diff --git a/src/Api/AccountsApi.php b/src/Api/AccountsApi.php index 74354b4a..a1c000ae 100644 --- a/src/Api/AccountsApi.php +++ b/src/Api/AccountsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -987,6 +987,10 @@ public function createWithHttpInfo($new_account_definition = null, AccountsApi\C } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1084,6 +1088,10 @@ public function createBrandWithHttpInfo($account_id, $brand = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1191,6 +1199,10 @@ public function createCustomFieldWithHttpInfo($account_id, $custom_field = null, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1298,6 +1310,10 @@ public function createPermissionProfileWithHttpInfo($account_id, $permission_pro } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1388,6 +1404,10 @@ public function deleteWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1488,6 +1508,10 @@ public function deleteBrandWithHttpInfo($account_id, $brand_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1602,6 +1626,10 @@ public function deleteBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1695,6 +1723,10 @@ public function deleteBrandsWithHttpInfo($account_id, $brands_request = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1806,6 +1838,10 @@ public function deleteCaptiveRecipientWithHttpInfo($account_id, $recipient_part, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1920,6 +1956,10 @@ public function deleteCustomFieldWithHttpInfo($account_id, $custom_field_id, Acc } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2006,6 +2046,10 @@ public function deleteENoteConfigurationWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2116,6 +2160,10 @@ public function deletePermissionProfileWithHttpInfo($account_id, $permission_pro } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2202,6 +2250,10 @@ public function getAccountIdentityVerificationWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2302,6 +2354,10 @@ public function getAccountInformationWithHttpInfo($account_id, AccountsApi\GetAc } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2392,6 +2448,10 @@ public function getAccountTabSettingsWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2482,6 +2542,10 @@ public function getAllPaymentGatewayAccountsWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2582,6 +2646,10 @@ public function getBillingChargesWithHttpInfo($account_id, AccountsApi\GetBillin } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2700,6 +2768,10 @@ public function getBrandWithHttpInfo($account_id, $brand_id, AccountsApi\GetBran } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2804,6 +2876,10 @@ public function getBrandExportFileWithHttpInfo($account_id, $brand_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2918,6 +2994,10 @@ public function getBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_typ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3022,6 +3102,10 @@ public function getBrandResourcesWithHttpInfo($account_id, $brand_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3154,6 +3238,10 @@ public function getBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_i } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3254,6 +3342,10 @@ public function getConsumerDisclosureWithHttpInfo($account_id, $lang_code) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3354,6 +3446,10 @@ public function getConsumerDisclosureDefaultWithHttpInfo($account_id, AccountsAp } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3444,6 +3540,10 @@ public function getENoteConfigurationWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3534,6 +3634,10 @@ public function getEnvelopePurgeConfigurationWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3624,6 +3728,10 @@ public function getFavoriteTemplatesWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3714,6 +3822,10 @@ public function getNotificationDefaultsWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3804,6 +3916,10 @@ public function getPasswordRulesWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3880,6 +3996,10 @@ public function getPasswordRules_0WithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3994,6 +4114,10 @@ public function getPermissionProfileWithHttpInfo($account_id, $permission_profil } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4070,6 +4194,10 @@ public function getProvisioningWithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4160,6 +4288,10 @@ public function getSupportedLanguagesWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4250,6 +4382,10 @@ public function getWatermarkWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4347,6 +4483,10 @@ public function getWatermarkPreviewWithHttpInfo($account_id, $watermark = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4451,6 +4591,10 @@ public function listBrandsWithHttpInfo($account_id, AccountsApi\ListBrandsOption } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4541,6 +4685,10 @@ public function listCustomFieldsWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4641,6 +4789,10 @@ public function listPermissionsWithHttpInfo($account_id, AccountsApi\ListPermiss } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4741,6 +4893,10 @@ public function listRecipientNamesByEmailWithHttpInfo($account_id, AccountsApi\L } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4831,6 +4987,10 @@ public function listSettingsWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4959,6 +5119,10 @@ public function listSharedAccessWithHttpInfo($account_id, AccountsApi\ListShared } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5049,6 +5213,10 @@ public function listSignatureProvidersWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5139,6 +5307,10 @@ public function listUnsupportedFileTypesWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5236,6 +5408,10 @@ public function unFavoriteTemplateWithHttpInfo($account_id, $favorite_templates_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5333,6 +5509,10 @@ public function updateAccountTabSettingsWithHttpInfo($account_id, $tab_account_s } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5444,6 +5624,10 @@ public function updateBrandWithHttpInfo($account_id, $brand_id, $brand = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5573,6 +5757,10 @@ public function updateBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5687,6 +5875,10 @@ public function updateBrandResourcesByContentTypeWithHttpInfo($account_id, $bran } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5808,6 +6000,10 @@ public function updateConsumerDisclosureWithHttpInfo($account_id, $lang_code, $c } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5929,6 +6125,10 @@ public function updateCustomFieldWithHttpInfo($account_id, $custom_field_id, $cu } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6026,6 +6226,10 @@ public function updateENoteConfigurationWithHttpInfo($account_id, $e_note_config } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6123,6 +6327,10 @@ public function updateEnvelopePurgeConfigurationWithHttpInfo($account_id, $envel } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6220,6 +6428,10 @@ public function updateFavoriteTemplateWithHttpInfo($account_id, $favorite_templa } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6317,6 +6529,10 @@ public function updateNotificationDefaultsWithHttpInfo($account_id, $notificatio } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6414,6 +6630,10 @@ public function updatePasswordRulesWithHttpInfo($account_id, $account_password_r } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6535,6 +6755,10 @@ public function updatePermissionProfileWithHttpInfo($account_id, $permission_pro } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6632,6 +6856,10 @@ public function updateSettingsWithHttpInfo($account_id, $account_settings_inform } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6743,6 +6971,10 @@ public function updateSharedAccessWithHttpInfo($account_id, $account_shared_acce } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6840,6 +7072,10 @@ public function updateWatermarkWithHttpInfo($account_id, $watermark = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/AuthenticationApi.php b/src/Api/AuthenticationApi.php index b4800b9f..9f36c421 100644 --- a/src/Api/AuthenticationApi.php +++ b/src/Api/AuthenticationApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -276,6 +276,10 @@ public function deleteSocialLoginWithHttpInfo($account_id, $user_id, $social_acc } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -348,6 +352,10 @@ public function getOAuthTokenWithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -452,6 +460,10 @@ public function listSocialLoginsWithHttpInfo($account_id, $user_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -550,6 +562,10 @@ public function loginWithHttpInfo(AuthenticationApi\LoginOptions $options = null } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -626,6 +642,10 @@ public function revokeOAuthTokenWithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -719,6 +739,10 @@ public function updatePasswordWithHttpInfo($login_part, $user_password_informati } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -826,6 +850,10 @@ public function updateSocialLoginWithHttpInfo($account_id, $user_id, $social_acc } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/BillingApi.php b/src/Api/BillingApi.php index 20705f67..3e9488e9 100644 --- a/src/Api/BillingApi.php +++ b/src/Api/BillingApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -364,6 +364,10 @@ public function getBillingPlanWithHttpInfo($billing_plan_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -454,6 +458,10 @@ public function getCreditCardInfoWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -483,6 +491,100 @@ public function getCreditCardInfoWithHttpInfo($account_id) } } + /** + * Operation getDowngradeRequestBillingInfo + * + * Returns downgrade plan information for the specified account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\Client\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\DowngradRequestBillingInfoResponse + */ + public function getDowngradeRequestBillingInfo($account_id) + { + list($response) = $this->getDowngradeRequestBillingInfoWithHttpInfo($account_id); + return $response; + } + + /** + * Operation getDowngradeRequestBillingInfoWithHttpInfo + * + * Returns downgrade plan information for the specified account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\Client\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\DowngradRequestBillingInfoResponse, HTTP status code, HTTP response headers (array of strings) + */ + public function getDowngradeRequestBillingInfoWithHttpInfo($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 getDowngradeRequestBillingInfo'); + } + // parse inputs + $resourcePath = "/v2.1/accounts/{accountId}/billing_plan/downgrade"; + $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) + } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\DowngradRequestBillingInfoResponse', + '/v2.1/accounts/{accountId}/billing_plan/downgrade' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\DowngradRequestBillingInfoResponse', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\DowngradRequestBillingInfoResponse', $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 * @@ -558,6 +660,10 @@ public function getInvoiceWithHttpInfo($account_id, $invoice_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -662,6 +768,10 @@ public function getPaymentWithHttpInfo($account_id, $payment_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -770,6 +880,10 @@ public function getPlanWithHttpInfo($account_id, BillingApi\GetPlanOptions $opti } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -846,6 +960,10 @@ public function listBillingPlansWithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -950,6 +1068,10 @@ public function listInvoicesWithHttpInfo($account_id, BillingApi\ListInvoicesOpt } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1040,6 +1162,10 @@ public function listInvoicesPastDueWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1144,6 +1270,10 @@ public function listPaymentsWithHttpInfo($account_id, BillingApi\ListPaymentsOpt } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1241,6 +1371,10 @@ public function makePaymentWithHttpInfo($account_id, $billing_payment_request = } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1338,6 +1472,10 @@ public function purchaseEnvelopesWithHttpInfo($account_id, $purchased_envelopes_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1431,6 +1569,10 @@ public function updateDowngradeAccountBillingPlanWithHttpInfo($account_id, $down } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1538,6 +1680,10 @@ public function updatePlanWithHttpInfo($account_id, $billing_plan_information = } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/BulkEnvelopesApi.php b/src/Api/BulkEnvelopesApi.php index 159e0d3a..333b891e 100644 --- a/src/Api/BulkEnvelopesApi.php +++ b/src/Api/BulkEnvelopesApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -379,6 +379,10 @@ public function callListWithHttpInfo($account_id, BulkEnvelopesApi\ListOptions $ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -476,6 +480,10 @@ public function createBulkSendListWithHttpInfo($account_id, $bulk_sending_list = } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -587,6 +595,10 @@ public function createBulkSendRequestWithHttpInfo($account_id, $bulk_send_list_i } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -698,6 +710,10 @@ public function createBulkSendTestRequestWithHttpInfo($account_id, $bulk_send_li } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -802,6 +818,10 @@ public function deleteBulkSendListWithHttpInfo($account_id, $bulk_send_list_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -920,6 +940,10 @@ public function deleteRecipientsWithHttpInfo($account_id, $envelope_id, $recipie } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1042,6 +1066,10 @@ public function getWithHttpInfo($account_id, $batch_id, BulkEnvelopesApi\GetOpti } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1146,6 +1174,10 @@ public function getBulkSendListWithHttpInfo($account_id, $bulk_send_list_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1236,6 +1268,10 @@ public function getBulkSendListsWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1368,6 +1404,10 @@ public function getRecipientsWithHttpInfo($account_id, $envelope_id, $recipient_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1479,6 +1519,10 @@ public function updateBulkSendListWithHttpInfo($account_id, $bulk_send_list_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1514,7 +1558,7 @@ public function updateBulkSendListWithHttpInfo($account_id, $bulk_send_list_id, * Adds or replaces envelope bulk recipients. * * @param string $account_id The external account number (int) or account ID GUID. - * @param string $envelope_id The envelope's GUID. Example: `93be49ab-afa0-4adf-933c-f752070d71ec` + * @param string $envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` * @param string $recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. * @param string $bulk_recipients_request (required) * @throws \DocuSign\eSign\Client\ApiException on non-2xx response @@ -1532,7 +1576,7 @@ public function updateRecipients($account_id, $envelope_id, $recipient_id, $bulk * Adds or replaces envelope bulk recipients. * * @param string $account_id The external account number (int) or account ID GUID. - * @param string $envelope_id The envelope's GUID. Example: `93be49ab-afa0-4adf-933c-f752070d71ec` + * @param string $envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` * @param string $recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. * @param string $bulk_recipients_request (required) * @throws \DocuSign\eSign\Client\ApiException on non-2xx response @@ -1608,6 +1652,10 @@ public function updateRecipientsWithHttpInfo($account_id, $envelope_id, $recipie } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/CloudStorageApi.php b/src/Api/CloudStorageApi.php index 1e43197e..1019bfc5 100644 --- a/src/Api/CloudStorageApi.php +++ b/src/Api/CloudStorageApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -615,6 +615,10 @@ public function callListWithHttpInfo($account_id, $folder_id, $service_id, $user } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -726,6 +730,10 @@ public function createProviderWithHttpInfo($account_id, $user_id, $cloud_storage } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -844,6 +852,10 @@ public function deleteProviderWithHttpInfo($account_id, $service_id, $user_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -955,6 +967,10 @@ public function deleteProvidersWithHttpInfo($account_id, $user_id, $cloud_storag } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1083,6 +1099,10 @@ public function getProviderWithHttpInfo($account_id, $service_id, $user_id, Clou } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1231,6 +1251,10 @@ public function listFoldersWithHttpInfo($account_id, $service_id, $user_id, Clou } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1345,6 +1369,10 @@ public function listProvidersWithHttpInfo($account_id, $user_id, CloudStorageApi } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/ConnectApi.php b/src/Api/ConnectApi.php index f9154fd1..052b37ff 100644 --- a/src/Api/ConnectApi.php +++ b/src/Api/ConnectApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -446,6 +446,10 @@ public function createConfigurationWithHttpInfo($account_id, $connect_custom_con } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -550,6 +554,10 @@ public function deleteConfigurationWithHttpInfo($account_id, $connect_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -650,6 +658,10 @@ public function deleteEventFailureLogWithHttpInfo($account_id, $failure_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -750,6 +762,10 @@ public function deleteEventLogWithHttpInfo($account_id, $log_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -836,6 +852,10 @@ public function deleteEventLogsWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -929,6 +949,10 @@ public function deleteMobileNotifiersWithHttpInfo($account_id, $mobile_notifier_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1033,6 +1057,10 @@ public function getConfigurationWithHttpInfo($account_id, $connect_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1147,6 +1175,10 @@ public function getEventLogWithHttpInfo($account_id, $log_id, ConnectApi\GetEven } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1237,6 +1269,10 @@ public function listConfigurationsWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1341,6 +1377,10 @@ public function listEventFailureLogsWithHttpInfo($account_id, ConnectApi\ListEve } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1445,6 +1485,10 @@ public function listEventLogsWithHttpInfo($account_id, ConnectApi\ListEventLogsO } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1535,6 +1579,10 @@ public function listMobileNotifiersWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1639,6 +1687,10 @@ public function listTestsWithHttpInfo($account_id, $connect_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1773,6 +1825,10 @@ public function listUsersWithHttpInfo($account_id, $connect_id, ConnectApi\ListU } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1877,6 +1933,10 @@ public function retryEventForEnvelopeWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1974,6 +2034,10 @@ public function retryEventForEnvelopesWithHttpInfo($account_id, $connect_failure } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2071,6 +2135,10 @@ public function updateConfigurationWithHttpInfo($account_id, $connect_custom_con } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2168,6 +2236,10 @@ public function updateMobileNotifiersWithHttpInfo($account_id, $mobile_notifier_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/CustomTabsApi.php b/src/Api/CustomTabsApi.php index 57103ee4..d4e35736 100644 --- a/src/Api/CustomTabsApi.php +++ b/src/Api/CustomTabsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -190,6 +190,10 @@ public function callListWithHttpInfo($account_id, CustomTabsApi\ListOptions $opt } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -287,6 +291,10 @@ public function createWithHttpInfo($account_id, $tab_metadata = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -391,6 +399,10 @@ public function deleteWithHttpInfo($account_id, $custom_tab_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -491,6 +503,10 @@ public function getWithHttpInfo($account_id, $custom_tab_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -602,6 +618,10 @@ public function updateWithHttpInfo($account_id, $custom_tab_id, $tab_metadata = } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/DataFeedApi.php b/src/Api/DataFeedApi.php index 9842963c..301dfccb 100644 --- a/src/Api/DataFeedApi.php +++ b/src/Api/DataFeedApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -166,6 +166,10 @@ public function getDataFeedElementWithHttpInfo($account_id, $data_feed_element_i } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/DiagnosticsApi.php b/src/Api/DiagnosticsApi.php index 60d795e2..a23a0eaa 100644 --- a/src/Api/DiagnosticsApi.php +++ b/src/Api/DiagnosticsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -166,6 +166,10 @@ public function deleteRequestLogsWithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -252,6 +256,10 @@ public function getRequestLogWithHttpInfo($request_log_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -328,6 +336,10 @@ public function getRequestLogSettingsWithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -404,6 +416,10 @@ public function getResourcesWithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -480,6 +496,10 @@ public function getServiceWithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -566,6 +586,10 @@ public function listRequestLogsWithHttpInfo(DiagnosticsApi\ListRequestLogsOption } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -649,6 +673,10 @@ public function updateRequestLogSettingsWithHttpInfo($diagnostics_settings_infor } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/EmailArchiveApi.php b/src/Api/EmailArchiveApi.php index f1307f20..59bb4f1a 100644 --- a/src/Api/EmailArchiveApi.php +++ b/src/Api/EmailArchiveApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -28,7 +28,7 @@ namespace DocuSign\eSign\Api\EmailArchiveApi; -class GetBccEmailArchiveHistoryListOptions +class GetBCCEmailArchiveHistoryListOptions { /** * $count @@ -81,7 +81,7 @@ public function setStartPosition($start_position) return $this; } } -class GetBccEmailArchiveListOptions +class GetBCCEmailArchiveListOptions { /** * $count @@ -265,6 +265,10 @@ public function createBCCEmailArchiveWithHttpInfo($account_id, $bcc_email_archiv } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -369,6 +373,10 @@ public function deleteBCCEmailArchiveWithHttpInfo($account_id, $bcc_email_archiv } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -405,7 +413,7 @@ public function deleteBCCEmailArchiveWithHttpInfo($account_id, $bcc_email_archiv * @throws \DocuSign\eSign\Client\ApiException on non-2xx response * @return \DocuSign\eSign\Model\BccEmailArchiveHistoryList */ - public function getBCCEmailArchiveHistoryList($account_id, $bcc_email_archive_id, EmailArchiveApi\GetBccEmailArchiveHistoryListOptions $options = null) + public function getBCCEmailArchiveHistoryList($account_id, $bcc_email_archive_id, EmailArchiveApi\GetBCCEmailArchiveHistoryListOptions $options = null) { list($response) = $this->getBCCEmailArchiveHistoryListWithHttpInfo($account_id, $bcc_email_archive_id, $options); return $response; @@ -422,7 +430,7 @@ public function getBCCEmailArchiveHistoryList($account_id, $bcc_email_archive_id * @throws \DocuSign\eSign\Client\ApiException on non-2xx response * @return array of \DocuSign\eSign\Model\BccEmailArchiveHistoryList, HTTP status code, HTTP response headers (array of strings) */ - public function getBCCEmailArchiveHistoryListWithHttpInfo($account_id, $bcc_email_archive_id, EmailArchiveApi\GetBccEmailArchiveHistoryListOptions $options = null) + public function getBCCEmailArchiveHistoryListWithHttpInfo($account_id, $bcc_email_archive_id, EmailArchiveApi\GetBCCEmailArchiveHistoryListOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { @@ -483,6 +491,10 @@ public function getBCCEmailArchiveHistoryListWithHttpInfo($account_id, $bcc_emai } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -522,7 +534,7 @@ public function getBCCEmailArchiveHistoryListWithHttpInfo($account_id, $bcc_emai * @throws \DocuSign\eSign\Client\ApiException on non-2xx response * @return \DocuSign\eSign\Model\BccEmailArchiveList */ - public function getBCCEmailArchiveList($account_id, EmailArchiveApi\GetBccEmailArchiveListOptions $options = null) + public function getBCCEmailArchiveList($account_id, EmailArchiveApi\GetBCCEmailArchiveListOptions $options = null) { list($response) = $this->getBCCEmailArchiveListWithHttpInfo($account_id, $options); return $response; @@ -538,7 +550,7 @@ public function getBCCEmailArchiveList($account_id, EmailArchiveApi\GetBccEmailA * @throws \DocuSign\eSign\Client\ApiException on non-2xx response * @return array of \DocuSign\eSign\Model\BccEmailArchiveList, HTTP status code, HTTP response headers (array of strings) */ - public function getBCCEmailArchiveListWithHttpInfo($account_id, EmailArchiveApi\GetBccEmailArchiveListOptions $options = null) + public function getBCCEmailArchiveListWithHttpInfo($account_id, EmailArchiveApi\GetBCCEmailArchiveListOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { @@ -587,6 +599,10 @@ public function getBCCEmailArchiveListWithHttpInfo($account_id, EmailArchiveApi\ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/EnvelopesApi.php b/src/Api/EnvelopesApi.php index 38ceb8be..a6262bf0 100644 --- a/src/Api/EnvelopesApi.php +++ b/src/Api/EnvelopesApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -28,6 +28,62 @@ namespace DocuSign\eSign\Api\EnvelopesApi; +class ApplyTemplateOptions +{ + /** + * $preserve_template_recipient + * @var string + */ + protected $preserve_template_recipient; + + /** + * Gets preserve_template_recipient + * @return string + */ + public function getPreserveTemplateRecipient() + { + return $this->preserve_template_recipient; + } + + /** + * Sets preserve_template_recipient + * @param string $preserve_template_recipient + * @return $this + */ + public function setPreserveTemplateRecipient($preserve_template_recipient) + { + $this->preserve_template_recipient = $preserve_template_recipient; + return $this; + } +} +class ApplyTemplateToDocumentOptions +{ + /** + * $preserve_template_recipient + * @var string + */ + protected $preserve_template_recipient; + + /** + * Gets preserve_template_recipient + * @return string + */ + public function getPreserveTemplateRecipient() + { + return $this->preserve_template_recipient; + } + + /** + * Sets preserve_template_recipient + * @param string $preserve_template_recipient + * @return $this + */ + public function setPreserveTemplateRecipient($preserve_template_recipient) + { + $this->preserve_template_recipient = $preserve_template_recipient; + return $this; + } +} class CreateEnvelopeOptions { /** @@ -2646,12 +2702,13 @@ public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) * @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\DocumentTemplateList $document_template_list (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\Client\ApiException on non-2xx response * @return \DocuSign\eSign\Model\DocumentTemplateList */ - public function applyTemplate($account_id, $envelope_id, $document_template_list = null) + public function applyTemplate($account_id, $envelope_id, $document_template_list = null, EnvelopesApi\ApplyTemplateOptions $options = null) { - list($response) = $this->applyTemplateWithHttpInfo($account_id, $envelope_id, $document_template_list); + list($response) = $this->applyTemplateWithHttpInfo($account_id, $envelope_id, $document_template_list, $options); return $response; } @@ -2663,10 +2720,11 @@ public function applyTemplate($account_id, $envelope_id, $document_template_list * @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\DocumentTemplateList $document_template_list (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\Client\ApiException on non-2xx response * @return array of \DocuSign\eSign\Model\DocumentTemplateList, HTTP status code, HTTP response headers (array of strings) */ - public function applyTemplateWithHttpInfo($account_id, $envelope_id, $document_template_list = null) + public function applyTemplateWithHttpInfo($account_id, $envelope_id, $document_template_list = null, EnvelopesApi\ApplyTemplateOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { @@ -2688,6 +2746,14 @@ public function applyTemplateWithHttpInfo($account_id, $envelope_id, $document_t } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getPreserveTemplateRecipient() !== null) { + $queryParams['preserve_template_recipient'] = $this->apiClient->getSerializer()->toQueryValue($options->getPreserveTemplateRecipient()); + } + } // path params if ($account_id !== null) { @@ -2720,6 +2786,10 @@ public function applyTemplateWithHttpInfo($account_id, $envelope_id, $document_t } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2758,12 +2828,13 @@ public function applyTemplateWithHttpInfo($account_id, $envelope_id, $document_t * @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\DocumentTemplateList $document_template_list (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\Client\ApiException on non-2xx response * @return \DocuSign\eSign\Model\DocumentTemplateList */ - public function applyTemplateToDocument($account_id, $document_id, $envelope_id, $document_template_list = null) + public function applyTemplateToDocument($account_id, $document_id, $envelope_id, $document_template_list = null, EnvelopesApi\ApplyTemplateToDocumentOptions $options = null) { - list($response) = $this->applyTemplateToDocumentWithHttpInfo($account_id, $document_id, $envelope_id, $document_template_list); + list($response) = $this->applyTemplateToDocumentWithHttpInfo($account_id, $document_id, $envelope_id, $document_template_list, $options); return $response; } @@ -2776,10 +2847,11 @@ public function applyTemplateToDocument($account_id, $document_id, $envelope_id, * @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\DocumentTemplateList $document_template_list (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\Client\ApiException on non-2xx response * @return array of \DocuSign\eSign\Model\DocumentTemplateList, HTTP status code, HTTP response headers (array of strings) */ - public function applyTemplateToDocumentWithHttpInfo($account_id, $document_id, $envelope_id, $document_template_list = null) + public function applyTemplateToDocumentWithHttpInfo($account_id, $document_id, $envelope_id, $document_template_list = null, EnvelopesApi\ApplyTemplateToDocumentOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { @@ -2805,6 +2877,14 @@ public function applyTemplateToDocumentWithHttpInfo($account_id, $document_id, $ } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getPreserveTemplateRecipient() !== null) { + $queryParams['preserve_template_recipient'] = $this->apiClient->getSerializer()->toQueryValue($options->getPreserveTemplateRecipient()); + } + } // path params if ($account_id !== null) { @@ -2845,6 +2925,10 @@ public function applyTemplateToDocumentWithHttpInfo($account_id, $document_id, $ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2942,6 +3026,10 @@ public function createChunkedUploadWithHttpInfo($account_id, $chunked_upload_req } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3039,6 +3127,10 @@ public function createConsoleViewWithHttpInfo($account_id, $console_view_request } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3150,6 +3242,10 @@ public function createCorrectViewWithHttpInfo($account_id, $envelope_id, $correc } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3261,6 +3357,10 @@ public function createCustomFieldsWithHttpInfo($account_id, $envelope_id, $custo } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3386,6 +3486,10 @@ public function createDocumentFieldsWithHttpInfo($account_id, $document_id, $env } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3511,6 +3615,10 @@ public function createDocumentResponsiveHtmlPreviewWithHttpInfo($account_id, $do } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3636,6 +3744,10 @@ public function createDocumentTabsWithHttpInfo($account_id, $document_id, $envel } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3747,6 +3859,10 @@ public function createEditViewWithHttpInfo($account_id, $envelope_id, $return_ur } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3858,6 +3974,10 @@ public function createEmailSettingsWithHttpInfo($account_id, $envelope_id, $emai } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3981,6 +4101,10 @@ public function createEnvelopeWithHttpInfo($account_id, $envelope_definition = n } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4092,6 +4216,10 @@ public function createEnvelopeCommentsWithHttpInfo($account_id, $envelope_id, $c } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4203,6 +4331,10 @@ public function createEnvelopeRecipientPreviewWithHttpInfo($account_id, $envelop } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4314,6 +4446,10 @@ public function createEnvelopeRecipientSharedViewWithHttpInfo($account_id, $enve } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4411,6 +4547,10 @@ public function createEnvelopeTransferRulesWithHttpInfo($account_id, $envelope_t } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4522,6 +4662,10 @@ public function createLockWithHttpInfo($account_id, $envelope_id, $lock_request } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4643,6 +4787,10 @@ public function createRecipientWithHttpInfo($account_id, $envelope_id, $recipien } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4761,6 +4909,10 @@ public function createRecipientProofFileLinkWithHttpInfo($account_id, $envelope_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4893,6 +5045,10 @@ public function createRecipientProofFileResourceTokenWithHttpInfo($account_id, $ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5004,6 +5160,10 @@ public function createRecipientViewWithHttpInfo($account_id, $envelope_id, $reci } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5115,6 +5275,10 @@ public function createResponsiveHtmlPreviewWithHttpInfo($account_id, $envelope_i } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5226,6 +5390,10 @@ public function createSenderViewWithHttpInfo($account_id, $envelope_id, $return_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5351,6 +5519,10 @@ public function createTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5462,6 +5634,10 @@ public function deleteAttachmentsWithHttpInfo($account_id, $envelope_id, $envelo } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5566,6 +5742,10 @@ public function deleteChunkedUploadWithHttpInfo($account_id, $chunked_upload_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5677,6 +5857,10 @@ public function deleteCustomFieldsWithHttpInfo($account_id, $envelope_id, $custo } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5802,6 +5986,10 @@ public function deleteDocumentFieldsWithHttpInfo($account_id, $document_id, $env } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5934,6 +6122,10 @@ public function deleteDocumentPageWithHttpInfo($account_id, $document_id, $envel } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6055,6 +6247,10 @@ public function deleteDocumentTabsWithHttpInfo($account_id, $document_id, $envel } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6166,6 +6362,10 @@ public function deleteDocumentsWithHttpInfo($account_id, $envelope_id, $envelope } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6270,6 +6470,10 @@ public function deleteEmailSettingsWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6374,6 +6578,10 @@ public function deleteEnvelopeTransferRulesWithHttpInfo($account_id, $envelope_t } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6474,6 +6682,10 @@ public function deleteLockWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6592,6 +6804,10 @@ public function deleteRecipientWithHttpInfo($account_id, $envelope_id, $recipien } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6703,6 +6919,10 @@ public function deleteRecipientsWithHttpInfo($account_id, $envelope_id, $recipie } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6828,6 +7048,10 @@ public function deleteTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6960,6 +7184,10 @@ public function deleteTemplatesFromDocumentWithHttpInfo($account_id, $document_i } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7074,6 +7302,10 @@ public function getAttachmentWithHttpInfo($account_id, $attachment_id, $envelope } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7174,6 +7406,10 @@ public function getAttachmentsWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7288,6 +7524,10 @@ public function getChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, En } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7402,6 +7642,10 @@ public function getCommentsTranscriptWithHttpInfo($account_id, $envelope_id, Env } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7544,6 +7788,10 @@ public function getConsumerDisclosureWithHttpInfo($account_id, $envelope_id, $la } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7672,6 +7920,10 @@ public function getConsumerDisclosureDefaultWithHttpInfo($account_id, $envelope_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7832,6 +8084,10 @@ public function getDocumentWithHttpInfo($account_id, $document_id, $envelope_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7986,6 +8242,10 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $env } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -8114,6 +8374,10 @@ public function getDocumentTabsWithHttpInfo($account_id, $document_id, $envelope } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -8218,6 +8482,10 @@ public function getEmailSettingsWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -8336,6 +8604,10 @@ public function getEnvelopeWithHttpInfo($account_id, $envelope_id, EnvelopesApi\ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -8454,6 +8726,10 @@ public function getEnvelopeDocumentHtmlDefinitionsWithHttpInfo($account_id, $doc } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -8558,6 +8834,10 @@ public function getEnvelopeHtmlDefinitionsWithHttpInfo($account_id, $envelope_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -8662,6 +8942,10 @@ public function getEnvelopeTransferRulesWithHttpInfo($account_id, EnvelopesApi\G } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -8766,6 +9050,10 @@ public function getFormDataWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -8870,6 +9158,10 @@ public function getLockWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -8974,6 +9266,10 @@ public function getNotificationSettingsWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -9106,6 +9402,10 @@ public function getPageTabsWithHttpInfo($account_id, $document_id, $envelope_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -9258,6 +9558,10 @@ public function getPagesWithHttpInfo($account_id, $document_id, $envelope_id, En } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -9376,6 +9680,10 @@ public function getRecipientDocumentVisibilityWithHttpInfo($account_id, $envelop } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -9504,6 +9812,10 @@ public function getRecipientInitialsImageWithHttpInfo($account_id, $envelope_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -9622,6 +9934,10 @@ public function getRecipientSignatureWithHttpInfo($account_id, $envelope_id, $re } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -9750,6 +10066,10 @@ public function getRecipientSignatureImageWithHttpInfo($account_id, $envelope_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -9854,6 +10174,10 @@ public function getTabsBlobWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -9968,6 +10292,10 @@ public function getTemplateRecipientDocumentVisibilityWithHttpInfo($account_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -10072,6 +10400,10 @@ public function listAuditEventsWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -10176,6 +10508,10 @@ public function listCustomFieldsWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -10294,6 +10630,10 @@ public function listDocumentFieldsWithHttpInfo($account_id, $document_id, $envel } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -10428,6 +10768,10 @@ public function listDocumentsWithHttpInfo($account_id, $envelope_id, EnvelopesAp } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -10554,6 +10898,10 @@ public function listRecipientsWithHttpInfo($account_id, $envelope_id, EnvelopesA } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -10705,6 +11053,10 @@ public function listStatusWithHttpInfo($account_id, $envelope_ids_request = null } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -10921,6 +11273,10 @@ public function listStatusChangesWithHttpInfo($account_id, EnvelopesApi\ListStat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -11053,6 +11409,10 @@ public function listTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, E } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -11167,6 +11527,10 @@ public function listTemplatesWithHttpInfo($account_id, $envelope_id, EnvelopesAp } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -11295,6 +11659,10 @@ public function listTemplatesForDocumentWithHttpInfo($account_id, $document_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -11420,6 +11788,10 @@ public function putAttachmentWithHttpInfo($account_id, $attachment_id, $envelope } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -11531,6 +11903,10 @@ public function putAttachmentsWithHttpInfo($account_id, $envelope_id, $envelope_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -11670,6 +12046,10 @@ public function rotateDocumentPageWithHttpInfo($account_id, $document_id, $envel } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -11791,6 +12171,10 @@ public function updateWithHttpInfo($account_id, $envelope_id, $envelope = null, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -11905,6 +12289,10 @@ public function updateChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -12030,6 +12418,10 @@ public function updateChunkedUploadPartWithHttpInfo($account_id, $chunked_upload } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -12141,6 +12533,10 @@ public function updateCustomFieldsWithHttpInfo($account_id, $envelope_id, $custo } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -12259,6 +12655,10 @@ public function updateDocumentWithHttpInfo($account_id, $document_id, $envelope_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -12384,6 +12784,10 @@ public function updateDocumentFieldsWithHttpInfo($account_id, $document_id, $env } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -12509,6 +12913,10 @@ public function updateDocumentTabsWithHttpInfo($account_id, $document_id, $envel } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -12620,6 +13028,10 @@ public function updateDocumentsWithHttpInfo($account_id, $envelope_id, $envelope } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -12731,6 +13143,10 @@ public function updateEmailSettingsWithHttpInfo($account_id, $envelope_id, $emai } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -12842,6 +13258,10 @@ public function updateEnvelopeTransferRuleWithHttpInfo($account_id, $envelope_tr } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -12939,6 +13359,10 @@ public function updateEnvelopeTransferRulesWithHttpInfo($account_id, $envelope_t } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -13050,6 +13474,10 @@ public function updateLockWithHttpInfo($account_id, $envelope_id, $lock_request } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -13161,6 +13589,10 @@ public function updateNotificationSettingsWithHttpInfo($account_id, $envelope_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -13286,6 +13718,10 @@ public function updateRecipientDocumentVisibilityWithHttpInfo($account_id, $enve } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -13404,6 +13840,10 @@ public function updateRecipientInitialsImageWithHttpInfo($account_id, $envelope_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -13518,6 +13958,10 @@ public function updateRecipientSignatureImageWithHttpInfo($account_id, $envelope } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -13643,6 +14087,10 @@ public function updateRecipientsWithHttpInfo($account_id, $envelope_id, $recipie } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -13754,6 +14202,10 @@ public function updateRecipientsDocumentVisibilityWithHttpInfo($account_id, $env } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -13879,6 +14331,10 @@ public function updateTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -13983,6 +14439,10 @@ public function updateTabsBlobWithHttpInfo($account_id, $envelope_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -14104,6 +14564,10 @@ public function updateTemplateRecipientDocumentVisibilityWithHttpInfo($account_i } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -14215,6 +14679,10 @@ public function updateTemplateRecipientsDocumentVisibilityWithHttpInfo($account_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/FoldersApi.php b/src/Api/FoldersApi.php index df8b148d..86c4550a 100644 --- a/src/Api/FoldersApi.php +++ b/src/Api/FoldersApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -712,6 +712,10 @@ public function callListWithHttpInfo($account_id, FoldersApi\ListOptions $option } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -854,6 +858,10 @@ public function listItemsWithHttpInfo($account_id, $folder_id, FoldersApi\ListIt } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -965,6 +973,10 @@ public function moveEnvelopesWithHttpInfo($account_id, $folder_id, $folders_requ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1107,6 +1119,10 @@ public function searchWithHttpInfo($account_id, $search_folder_id, FoldersApi\Se } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/GroupsApi.php b/src/Api/GroupsApi.php index 19cf5564..120da945 100644 --- a/src/Api/GroupsApi.php +++ b/src/Api/GroupsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -340,6 +340,10 @@ public function createGroupsWithHttpInfo($account_id, $group_information = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -451,6 +455,10 @@ public function deleteBrandsWithHttpInfo($account_id, $group_id, $brands_request } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -562,6 +570,10 @@ public function deleteGroupUsersWithHttpInfo($account_id, $group_id, $user_info_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -659,6 +671,10 @@ public function deleteGroupsWithHttpInfo($account_id, $group_information = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -763,6 +779,10 @@ public function getBrandsWithHttpInfo($account_id, $group_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -881,6 +901,10 @@ public function listGroupUsersWithHttpInfo($account_id, $group_id, GroupsApi\Lis } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -997,6 +1021,10 @@ public function listGroupsWithHttpInfo($account_id, GroupsApi\ListGroupsOptions } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1108,6 +1136,10 @@ public function updateBrandsWithHttpInfo($account_id, $group_id, $brands_request } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1219,6 +1251,10 @@ public function updateGroupUsersWithHttpInfo($account_id, $group_id, $user_info_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1316,6 +1352,10 @@ public function updateGroupsWithHttpInfo($account_id, $group_information = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/NotaryApi.php b/src/Api/NotaryApi.php index 7607e024..07b52267 100644 --- a/src/Api/NotaryApi.php +++ b/src/Api/NotaryApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -251,6 +251,10 @@ public function createNotaryWithHttpInfo($notary = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -334,6 +338,10 @@ public function createNotaryJurisdictionsWithHttpInfo($notary_jurisdiction = nul } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -424,6 +432,10 @@ public function deleteNotaryJurisdictionWithHttpInfo($jurisdiction_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -506,6 +518,10 @@ public function getNotaryWithHttpInfo(NotaryApi\GetNotaryOptions $options = null } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -596,6 +612,10 @@ public function getNotaryJurisdictionWithHttpInfo($jurisdiction_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -686,6 +706,10 @@ public function getNotaryJurisdictionSealWithHttpInfo($jurisdiction_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -758,6 +782,10 @@ public function getNotaryJurisdictionsWithHttpInfo() } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -852,6 +880,10 @@ public function listNotaryJournalsWithHttpInfo(NotaryApi\ListNotaryJournalsOptio } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -935,6 +967,10 @@ public function updateNotaryWithHttpInfo($notary = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1032,6 +1068,10 @@ public function updateNotaryJurisdictionWithHttpInfo($jurisdiction_id, $notary_j } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/OrganizationsApi.php b/src/Api/OrganizationsApi.php index 9ebda46e..c0cc04a9 100644 --- a/src/Api/OrganizationsApi.php +++ b/src/Api/OrganizationsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -166,6 +166,10 @@ public function deleteReportWithHttpInfo($organization_id, $report_correlation_i } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -266,6 +270,10 @@ public function getReportWithHttpInfo($organization_id, $report_correlation_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/PowerFormsApi.php b/src/Api/PowerFormsApi.php index df7840c6..1bda4b1d 100644 --- a/src/Api/PowerFormsApi.php +++ b/src/Api/PowerFormsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -368,6 +368,10 @@ public function createPowerFormWithHttpInfo($account_id, $power_form = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -472,6 +476,10 @@ public function deletePowerFormWithHttpInfo($account_id, $power_form_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -565,6 +573,10 @@ public function deletePowerFormsWithHttpInfo($account_id, $power_forms_request = } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -669,6 +681,10 @@ public function getPowerFormWithHttpInfo($account_id, $power_form_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -791,6 +807,10 @@ public function getPowerFormDataWithHttpInfo($account_id, $power_form_id, PowerF } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -891,6 +911,10 @@ public function listPowerFormSendersWithHttpInfo($account_id, PowerFormsApi\List } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1003,6 +1027,10 @@ public function listPowerFormsWithHttpInfo($account_id, PowerFormsApi\ListPowerF } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1114,6 +1142,10 @@ public function updatePowerFormWithHttpInfo($account_id, $power_form_id, $power_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/SigningGroupsApi.php b/src/Api/SigningGroupsApi.php index e0698ce0..835650e8 100644 --- a/src/Api/SigningGroupsApi.php +++ b/src/Api/SigningGroupsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -219,6 +219,10 @@ public function callListWithHttpInfo($account_id, SigningGroupsApi\ListOptions $ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -316,6 +320,10 @@ public function createListWithHttpInfo($account_id, $signing_group_information = } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -413,6 +421,10 @@ public function deleteListWithHttpInfo($account_id, $signing_group_information = } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -524,6 +536,10 @@ public function deleteUsersWithHttpInfo($account_id, $signing_group_id, $signing } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -628,6 +644,10 @@ public function getWithHttpInfo($account_id, $signing_group_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -732,6 +752,10 @@ public function listUsersWithHttpInfo($account_id, $signing_group_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -843,6 +867,10 @@ public function updateWithHttpInfo($account_id, $signing_group_id, $signing_grou } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -940,6 +968,10 @@ public function updateListWithHttpInfo($account_id, $signing_group_information = } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1051,6 +1083,10 @@ public function updateUsersWithHttpInfo($account_id, $signing_group_id, $signing } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/TemplatesApi.php b/src/Api/TemplatesApi.php index f6092ac7..7e07593b 100644 --- a/src/Api/TemplatesApi.php +++ b/src/Api/TemplatesApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -1412,6 +1412,10 @@ public function createCustomFieldsWithHttpInfo($account_id, $template_id, $templ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1537,6 +1541,10 @@ public function createDocumentFieldsWithHttpInfo($account_id, $document_id, $tem } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1648,6 +1656,10 @@ public function createEditViewWithHttpInfo($account_id, $template_id, $return_ur } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1759,6 +1771,10 @@ public function createLockWithHttpInfo($account_id, $template_id, $lock_request } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1880,6 +1896,10 @@ public function createRecipientsWithHttpInfo($account_id, $template_id, $templat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2005,6 +2025,10 @@ public function createTabsWithHttpInfo($account_id, $recipient_id, $template_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2102,6 +2126,10 @@ public function createTemplateWithHttpInfo($account_id, $envelope_template = nul } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2227,6 +2255,10 @@ public function createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo($account } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2352,6 +2384,10 @@ public function createTemplateDocumentTabsWithHttpInfo($account_id, $document_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2463,6 +2499,10 @@ public function createTemplateRecipientPreviewWithHttpInfo($account_id, $templat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2574,6 +2614,10 @@ public function createTemplateResponsiveHtmlPreviewWithHttpInfo($account_id, $te } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2692,6 +2736,10 @@ public function deleteBulkRecipientsWithHttpInfo($account_id, $recipient_id, $te } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2803,6 +2851,10 @@ public function deleteCustomFieldsWithHttpInfo($account_id, $template_id, $templ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2928,6 +2980,10 @@ public function deleteDocumentFieldsWithHttpInfo($account_id, $document_id, $tem } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3067,6 +3123,10 @@ public function deleteDocumentPageWithHttpInfo($account_id, $document_id, $page_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3174,6 +3234,10 @@ public function deleteDocumentsWithHttpInfo($account_id, $template_id, $envelope } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3299,6 +3363,10 @@ public function deleteGroupShareWithHttpInfo($account_id, $template_id, $templat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3410,6 +3478,10 @@ public function deleteLockWithHttpInfo($account_id, $template_id, $lock_request } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3535,6 +3607,10 @@ public function deleteRecipientWithHttpInfo($account_id, $recipient_id, $templat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3646,6 +3722,10 @@ public function deleteRecipientsWithHttpInfo($account_id, $template_id, $templat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3771,6 +3851,10 @@ public function deleteTabsWithHttpInfo($account_id, $recipient_id, $template_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3896,6 +3980,10 @@ public function deleteTemplateDocumentTabsWithHttpInfo($account_id, $document_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4010,6 +4098,10 @@ public function getWithHttpInfo($account_id, $template_id, TemplatesApi\GetOptio } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4142,6 +4234,10 @@ public function getDocumentWithHttpInfo($account_id, $document_id, $template_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4296,6 +4392,10 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $pag } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4424,6 +4524,10 @@ public function getDocumentTabsWithHttpInfo($account_id, $document_id, $template } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4528,6 +4632,10 @@ public function getLockWithHttpInfo($account_id, $template_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4632,6 +4740,10 @@ public function getNotificationSettingsWithHttpInfo($account_id, $template_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4764,6 +4876,10 @@ public function getPageTabsWithHttpInfo($account_id, $document_id, $page_number, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -4916,6 +5032,10 @@ public function getPagesWithHttpInfo($account_id, $document_id, $template_id, Te } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5034,6 +5154,10 @@ public function getTemplateDocumentHtmlDefinitionsWithHttpInfo($account_id, $doc } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5138,6 +5262,10 @@ public function getTemplateHtmlDefinitionsWithHttpInfo($account_id, $template_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5270,6 +5398,10 @@ public function listBulkRecipientsWithHttpInfo($account_id, $recipient_id, $temp } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5374,6 +5506,10 @@ public function listCustomFieldsWithHttpInfo($account_id, $template_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5492,6 +5628,10 @@ public function listDocumentFieldsWithHttpInfo($account_id, $document_id, $templ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5606,6 +5746,10 @@ public function listDocumentsWithHttpInfo($account_id, $template_id, TemplatesAp } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5728,6 +5872,10 @@ public function listRecipientsWithHttpInfo($account_id, $template_id, TemplatesA } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -5860,6 +6008,10 @@ public function listTabsWithHttpInfo($account_id, $recipient_id, $template_id, T } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6044,6 +6196,10 @@ public function listTemplatesWithHttpInfo($account_id, TemplatesApi\ListTemplate } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6183,6 +6339,10 @@ public function rotateDocumentPageWithHttpInfo($account_id, $document_id, $page_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6290,6 +6450,10 @@ public function updateWithHttpInfo($account_id, $template_id, $envelope_template } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6415,6 +6579,10 @@ public function updateBulkRecipientsWithHttpInfo($account_id, $recipient_id, $te } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6526,6 +6694,10 @@ public function updateCustomFieldsWithHttpInfo($account_id, $template_id, $templ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6661,6 +6833,10 @@ public function updateDocumentWithHttpInfo($account_id, $document_id, $template_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6786,6 +6962,10 @@ public function updateDocumentFieldsWithHttpInfo($account_id, $document_id, $tem } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -6897,6 +7077,10 @@ public function updateDocumentsWithHttpInfo($account_id, $template_id, $envelope } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7022,6 +7206,10 @@ public function updateGroupShareWithHttpInfo($account_id, $template_id, $templat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7133,6 +7321,10 @@ public function updateLockWithHttpInfo($account_id, $template_id, $lock_request } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7244,6 +7436,10 @@ public function updateNotificationSettingsWithHttpInfo($account_id, $template_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7365,6 +7561,10 @@ public function updateRecipientsWithHttpInfo($account_id, $template_id, $templat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7490,6 +7690,10 @@ public function updateTabsWithHttpInfo($account_id, $recipient_id, $template_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -7615,6 +7819,10 @@ public function updateTemplateDocumentTabsWithHttpInfo($account_id, $document_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/UsersApi.php b/src/Api/UsersApi.php index 0d2a560b..2dbdd2ea 100644 --- a/src/Api/UsersApi.php +++ b/src/Api/UsersApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -729,6 +729,10 @@ public function callListWithHttpInfo($account_id, UsersApi\ListOptions $options } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -826,6 +830,10 @@ public function createWithHttpInfo($account_id, $new_users_definition = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -937,6 +945,10 @@ public function createSignaturesWithHttpInfo($account_id, $user_id, $user_signat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1044,6 +1056,10 @@ public function deleteWithHttpInfo($account_id, $user_info_list = null, UsersApi } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1148,6 +1164,10 @@ public function deleteContactWithIdWithHttpInfo($account_id, $contact_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1245,6 +1265,10 @@ public function deleteContactsWithHttpInfo($account_id, $contact_mod_request = n } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1356,6 +1380,10 @@ public function deleteCustomSettingsWithHttpInfo($account_id, $user_id, $custom_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1460,6 +1488,10 @@ public function deleteProfileImageWithHttpInfo($account_id, $user_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1574,6 +1606,10 @@ public function deleteSignatureWithHttpInfo($account_id, $signature_id, $user_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1702,6 +1738,10 @@ public function deleteSignatureImageWithHttpInfo($account_id, $image_type, $sign } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1816,6 +1856,10 @@ public function getContactByIdWithHttpInfo($account_id, $contact_id, UsersApi\Ge } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1934,6 +1978,10 @@ public function getInformationWithHttpInfo($account_id, $user_id, UsersApi\GetIn } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2038,6 +2086,10 @@ public function getProfileWithHttpInfo($account_id, $user_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2152,6 +2204,10 @@ public function getProfileImageWithHttpInfo($account_id, $user_id, UsersApi\GetP } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2256,6 +2312,10 @@ public function getSettingsWithHttpInfo($account_id, $user_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2374,6 +2434,10 @@ public function getSignatureWithHttpInfo($account_id, $signature_id, $user_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2516,6 +2580,10 @@ public function getSignatureImageWithHttpInfo($account_id, $image_type, $signatu } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2620,6 +2688,10 @@ public function listCustomSettingsWithHttpInfo($account_id, $user_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2734,6 +2806,10 @@ public function listSignaturesWithHttpInfo($account_id, $user_id, UsersApi\ListS } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2831,6 +2907,10 @@ public function postContactsWithHttpInfo($account_id, $contact_mod_request = nul } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -2928,6 +3008,10 @@ public function putContactsWithHttpInfo($account_id, $contact_mod_request = null } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3039,6 +3123,10 @@ public function updateCustomSettingsWithHttpInfo($account_id, $user_id, $custom_ } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3150,6 +3238,10 @@ public function updateProfileWithHttpInfo($account_id, $user_id, $user_profile = } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3250,6 +3342,10 @@ public function updateProfileImageWithHttpInfo($account_id, $user_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3357,6 +3453,10 @@ public function updateSettingsWithHttpInfo($account_id, $user_id, $user_settings } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3488,6 +3588,10 @@ public function updateSignatureWithHttpInfo($account_id, $signature_id, $user_id } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3630,6 +3734,10 @@ public function updateSignatureImageWithHttpInfo($account_id, $image_type, $sign } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3741,6 +3849,10 @@ public function updateSignaturesWithHttpInfo($account_id, $user_id, $user_signat } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3852,6 +3964,10 @@ public function updateUserWithHttpInfo($account_id, $user_id, $user_information } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -3949,6 +4065,10 @@ public function updateUsersWithHttpInfo($account_id, $user_information_list = nu } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/Api/WorkspacesApi.php b/src/Api/WorkspacesApi.php index f368f9c6..671df4fe 100644 --- a/src/Api/WorkspacesApi.php +++ b/src/Api/WorkspacesApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -518,6 +518,10 @@ public function createWorkspaceWithHttpInfo($account_id, $workspace = null) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -636,6 +640,10 @@ public function createWorkspaceFileWithHttpInfo($account_id, $folder_id, $worksp } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -740,6 +748,10 @@ public function deleteWorkspaceWithHttpInfo($account_id, $workspace_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -865,6 +877,10 @@ public function deleteWorkspaceFolderItemsWithHttpInfo($account_id, $folder_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -965,6 +981,10 @@ public function getWorkspaceWithHttpInfo($account_id, $workspace_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1111,6 +1131,10 @@ public function getWorkspaceFileWithHttpInfo($account_id, $file_id, $folder_id, } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1265,6 +1289,10 @@ public function listWorkspaceFilePagesWithHttpInfo($account_id, $file_id, $folde } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1417,6 +1445,10 @@ public function listWorkspaceFolderItemsWithHttpInfo($account_id, $folder_id, $w } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1507,6 +1539,10 @@ public function listWorkspacesWithHttpInfo($account_id) } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1618,6 +1654,10 @@ public function updateWorkspaceWithHttpInfo($account_id, $workspace_id, $workspa } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( @@ -1750,6 +1790,10 @@ public function updateWorkspaceFileWithHttpInfo($account_id, $file_id, $folder_i } elseif (count($formParams) > 0) { $httpBody = $formParams; // for HTTP post (form) } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } // make the API Call try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( diff --git a/src/HeaderSelector.php b/src/HeaderSelector.php new file mode 100644 index 00000000..5114b1a7 --- /dev/null +++ b/src/HeaderSelector.php @@ -0,0 +1,109 @@ +selectAcceptHeader($accept); + if ($accept !== null) { + $headers['Accept'] = $accept; + } + + $headers['Content-Type'] = $this->selectContentTypeHeader($contentTypes); + return $headers; + } + + /** + * @param string[] $accept + * @return array + */ + public function selectHeadersForMultipart($accept) + { + $headers = $this->selectHeaders($accept, []); + + unset($headers['Content-Type']); + return $headers; + } + + /** + * Return the header 'Accept' based on an array of Accept provided + * + * @param string[] $accept Array of header + * + * @return string Accept (e.g. application/json) + */ + private function selectAcceptHeader($accept) + { + if (count($accept) === 0 || (count($accept) === 1 && $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[] $contentType Array fo content-type + * + * @return string Content-Type (e.g. application/json) + */ + private function selectContentTypeHeader($contentType) + { + if (count($contentType) === 0 || (count($contentType) === 1 && $contentType[0] === '')) { + return 'application/json'; + } elseif (preg_grep("/application\/json/i", $contentType)) { + return 'application/json'; + } else { + return implode(',', $contentType); + } + } +} diff --git a/src/Model/AccessCodeFormat.php b/src/Model/AccessCodeFormat.php index 0a1cca57..ac47ddc1 100644 --- a/src/Model/AccessCodeFormat.php +++ b/src/Model/AccessCodeFormat.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccessCodeFormat Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccessCodeFormat implements ArrayAccess +class AccessCodeFormat implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accessCodeFormat'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class AccessCodeFormat implements ArrayAccess 'special_character_required_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'format_required' => null, + 'format_required_metadata' => null, + 'letter_required' => null, + 'letter_required_metadata' => null, + 'minimum_length' => null, + 'minimum_length_metadata' => null, + 'number_required' => null, + 'number_required_metadata' => null, + 'special_character_required' => null, + 'special_character_required_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'special_character_required_metadata' => 'specialCharacterRequiredMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'special_character_required_metadata' => 'setSpecialCharacterRequiredMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'special_character_required_metadata' => 'getSpecialCharacterRequiredMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets format_required + * * @return string */ public function getFormatRequired() @@ -201,7 +270,9 @@ public function getFormatRequired() /** * Sets format_required + * * @param string $format_required + * * @return $this */ public function setFormatRequired($format_required) @@ -213,6 +284,7 @@ public function setFormatRequired($format_required) /** * Gets format_required_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getFormatRequiredMetadata() @@ -222,7 +294,9 @@ public function getFormatRequiredMetadata() /** * Sets format_required_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $format_required_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $format_required_metadata format_required_metadata + * * @return $this */ public function setFormatRequiredMetadata($format_required_metadata) @@ -234,6 +308,7 @@ public function setFormatRequiredMetadata($format_required_metadata) /** * Gets letter_required + * * @return string */ public function getLetterRequired() @@ -243,7 +318,9 @@ public function getLetterRequired() /** * Sets letter_required + * * @param string $letter_required + * * @return $this */ public function setLetterRequired($letter_required) @@ -255,6 +332,7 @@ public function setLetterRequired($letter_required) /** * Gets letter_required_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getLetterRequiredMetadata() @@ -264,7 +342,9 @@ public function getLetterRequiredMetadata() /** * Sets letter_required_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $letter_required_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $letter_required_metadata letter_required_metadata + * * @return $this */ public function setLetterRequiredMetadata($letter_required_metadata) @@ -276,6 +356,7 @@ public function setLetterRequiredMetadata($letter_required_metadata) /** * Gets minimum_length + * * @return string */ public function getMinimumLength() @@ -285,7 +366,9 @@ public function getMinimumLength() /** * Sets minimum_length + * * @param string $minimum_length + * * @return $this */ public function setMinimumLength($minimum_length) @@ -297,6 +380,7 @@ public function setMinimumLength($minimum_length) /** * Gets minimum_length_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getMinimumLengthMetadata() @@ -306,7 +390,9 @@ public function getMinimumLengthMetadata() /** * Sets minimum_length_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $minimum_length_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $minimum_length_metadata minimum_length_metadata + * * @return $this */ public function setMinimumLengthMetadata($minimum_length_metadata) @@ -318,6 +404,7 @@ public function setMinimumLengthMetadata($minimum_length_metadata) /** * Gets number_required + * * @return string */ public function getNumberRequired() @@ -327,7 +414,9 @@ public function getNumberRequired() /** * Sets number_required + * * @param string $number_required + * * @return $this */ public function setNumberRequired($number_required) @@ -339,6 +428,7 @@ public function setNumberRequired($number_required) /** * Gets number_required_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getNumberRequiredMetadata() @@ -348,7 +438,9 @@ public function getNumberRequiredMetadata() /** * Sets number_required_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $number_required_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $number_required_metadata number_required_metadata + * * @return $this */ public function setNumberRequiredMetadata($number_required_metadata) @@ -360,6 +452,7 @@ public function setNumberRequiredMetadata($number_required_metadata) /** * Gets special_character_required + * * @return string */ public function getSpecialCharacterRequired() @@ -369,7 +462,9 @@ public function getSpecialCharacterRequired() /** * Sets special_character_required + * * @param string $special_character_required + * * @return $this */ public function setSpecialCharacterRequired($special_character_required) @@ -381,6 +476,7 @@ public function setSpecialCharacterRequired($special_character_required) /** * Gets special_character_required_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSpecialCharacterRequiredMetadata() @@ -390,7 +486,9 @@ public function getSpecialCharacterRequiredMetadata() /** * Sets special_character_required_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $special_character_required_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $special_character_required_metadata special_character_required_metadata + * * @return $this */ public function setSpecialCharacterRequiredMetadata($special_character_required_metadata) @@ -401,7 +499,9 @@ public function setSpecialCharacterRequiredMetadata($special_character_required_ } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountAddress.php b/src/Model/AccountAddress.php index 6149e900..a6a1eeaa 100644 --- a/src/Model/AccountAddress.php +++ b/src/Model/AccountAddress.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountAddress Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountAddress implements ArrayAccess +class AccountAddress implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountAddress'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -69,13 +72,50 @@ class AccountAddress implements ArrayAccess 'supported_countries' => '\DocuSign\eSign\Model\Country[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address1' => null, + 'address2' => null, + 'city' => null, + 'country' => null, + 'email' => null, + 'fax' => null, + 'first_name' => null, + 'last_name' => null, + 'phone' => null, + 'postal_code' => null, + 'state' => null, + 'supported_countries' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -93,9 +133,9 @@ public static function swaggerTypes() 'supported_countries' => 'supportedCountries' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -113,9 +153,9 @@ public static function swaggerTypes() 'supported_countries' => 'setSupportedCountries' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -133,34 +173,63 @@ public static function swaggerTypes() 'supported_countries' => 'getSupportedCountries' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -179,30 +248,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address1 + * * @return string */ public function getAddress1() @@ -212,7 +283,9 @@ public function getAddress1() /** * Sets address1 + * * @param string $address1 First Line of the address. Maximum length: 100 characters. + * * @return $this */ public function setAddress1($address1) @@ -224,6 +297,7 @@ public function setAddress1($address1) /** * Gets address2 + * * @return string */ public function getAddress2() @@ -233,7 +307,9 @@ public function getAddress2() /** * Sets address2 + * * @param string $address2 Second Line of the address. Maximum length: 100 characters. + * * @return $this */ public function setAddress2($address2) @@ -245,6 +321,7 @@ public function setAddress2($address2) /** * Gets city + * * @return string */ public function getCity() @@ -254,7 +331,9 @@ public function getCity() /** * Sets city + * * @param string $city The city value of the address. + * * @return $this */ public function setCity($city) @@ -266,6 +345,7 @@ public function setCity($city) /** * Gets country + * * @return string */ public function getCountry() @@ -275,7 +355,9 @@ public function getCountry() /** * Sets country + * * @param string $country Specifies the country associated with the address. + * * @return $this */ public function setCountry($country) @@ -287,6 +369,7 @@ public function setCountry($country) /** * Gets email + * * @return string */ public function getEmail() @@ -296,7 +379,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -308,6 +393,7 @@ public function setEmail($email) /** * Gets fax + * * @return string */ public function getFax() @@ -317,7 +403,9 @@ public function getFax() /** * Sets fax + * * @param string $fax + * * @return $this */ public function setFax($fax) @@ -329,6 +417,7 @@ public function setFax($fax) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -338,7 +427,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -350,6 +441,7 @@ public function setFirstName($first_name) /** * Gets last_name + * * @return string */ public function getLastName() @@ -359,7 +451,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -371,6 +465,7 @@ public function setLastName($last_name) /** * Gets phone + * * @return string */ public function getPhone() @@ -380,7 +475,9 @@ public function getPhone() /** * Sets phone + * * @param string $phone + * * @return $this */ public function setPhone($phone) @@ -392,6 +489,7 @@ public function setPhone($phone) /** * Gets postal_code + * * @return string */ public function getPostalCode() @@ -401,7 +499,9 @@ public function getPostalCode() /** * Sets postal_code + * * @param string $postal_code + * * @return $this */ public function setPostalCode($postal_code) @@ -413,6 +513,7 @@ public function setPostalCode($postal_code) /** * Gets state + * * @return string */ public function getState() @@ -422,7 +523,9 @@ public function getState() /** * Sets state + * * @param string $state The state or province associated with the address. + * * @return $this */ public function setState($state) @@ -434,6 +537,7 @@ public function setState($state) /** * Gets supported_countries + * * @return \DocuSign\eSign\Model\Country[] */ public function getSupportedCountries() @@ -443,7 +547,9 @@ public function getSupportedCountries() /** * Sets supported_countries + * * @param \DocuSign\eSign\Model\Country[] $supported_countries Contains an array of countries supported by the billing plan. + * * @return $this */ public function setSupportedCountries($supported_countries) @@ -454,7 +560,9 @@ public function setSupportedCountries($supported_countries) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -464,7 +572,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -474,8 +584,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -489,7 +601,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -499,16 +613,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountBillingPlan.php b/src/Model/AccountBillingPlan.php index 6343114b..3a93312f 100644 --- a/src/Model/AccountBillingPlan.php +++ b/src/Model/AccountBillingPlan.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountBillingPlan Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountBillingPlan implements ArrayAccess +class AccountBillingPlan implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountBillingPlan'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -78,13 +81,59 @@ class AccountBillingPlan implements ArrayAccess 'support_plan_fee' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'add_ons' => null, + 'can_cancel_renewal' => null, + 'can_upgrade' => null, + 'currency_code' => null, + 'downgrade_plan_information' => null, + 'enable_support' => null, + 'included_seats' => null, + 'incremental_seats' => null, + 'is_downgrade' => null, + 'other_discount_percent' => null, + 'payment_cycle' => null, + 'payment_method' => null, + 'per_seat_price' => null, + 'plan_classification' => null, + 'plan_feature_sets' => null, + 'plan_id' => null, + 'plan_name' => null, + 'renewal_status' => null, + 'seat_discounts' => null, + 'support_incident_fee' => null, + 'support_plan_fee' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -111,9 +160,9 @@ public static function swaggerTypes() 'support_plan_fee' => 'supportPlanFee' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -140,9 +189,9 @@ public static function swaggerTypes() 'support_plan_fee' => 'setSupportPlanFee' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -169,34 +218,63 @@ public static function swaggerTypes() 'support_plan_fee' => 'getSupportPlanFee' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -224,30 +302,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets add_ons + * * @return \DocuSign\eSign\Model\AddOn[] */ public function getAddOns() @@ -257,7 +337,9 @@ public function getAddOns() /** * Sets add_ons + * * @param \DocuSign\eSign\Model\AddOn[] $add_ons Reserved: + * * @return $this */ public function setAddOns($add_ons) @@ -269,6 +351,7 @@ public function setAddOns($add_ons) /** * Gets can_cancel_renewal + * * @return string */ public function getCanCancelRenewal() @@ -278,7 +361,9 @@ public function getCanCancelRenewal() /** * Sets can_cancel_renewal + * * @param string $can_cancel_renewal Reserved: TBD + * * @return $this */ public function setCanCancelRenewal($can_cancel_renewal) @@ -290,6 +375,7 @@ public function setCanCancelRenewal($can_cancel_renewal) /** * Gets can_upgrade + * * @return string */ public function getCanUpgrade() @@ -299,7 +385,9 @@ public function getCanUpgrade() /** * Sets can_upgrade + * * @param string $can_upgrade When set to **true**, specifies that you can upgrade the account through the API. + * * @return $this */ public function setCanUpgrade($can_upgrade) @@ -311,6 +399,7 @@ public function setCanUpgrade($can_upgrade) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -320,7 +409,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code Specifies the ISO currency code for the account. + * * @return $this */ public function setCurrencyCode($currency_code) @@ -332,6 +423,7 @@ public function setCurrencyCode($currency_code) /** * Gets downgrade_plan_information + * * @return \DocuSign\eSign\Model\DowngradePlanUpdateResponse */ public function getDowngradePlanInformation() @@ -341,7 +433,9 @@ public function getDowngradePlanInformation() /** * Sets downgrade_plan_information - * @param \DocuSign\eSign\Model\DowngradePlanUpdateResponse $downgrade_plan_information + * + * @param \DocuSign\eSign\Model\DowngradePlanUpdateResponse $downgrade_plan_information downgrade_plan_information + * * @return $this */ public function setDowngradePlanInformation($downgrade_plan_information) @@ -353,6 +447,7 @@ public function setDowngradePlanInformation($downgrade_plan_information) /** * Gets enable_support + * * @return string */ public function getEnableSupport() @@ -362,7 +457,9 @@ public function getEnableSupport() /** * Sets enable_support + * * @param string $enable_support When set to **true**, then customer support is provided as part of the account plan. + * * @return $this */ public function setEnableSupport($enable_support) @@ -374,6 +471,7 @@ public function setEnableSupport($enable_support) /** * Gets included_seats + * * @return string */ public function getIncludedSeats() @@ -383,7 +481,9 @@ public function getIncludedSeats() /** * Sets included_seats + * * @param string $included_seats The number of seats (users) included. + * * @return $this */ public function setIncludedSeats($included_seats) @@ -395,6 +495,7 @@ public function setIncludedSeats($included_seats) /** * Gets incremental_seats + * * @return string */ public function getIncrementalSeats() @@ -404,7 +505,9 @@ public function getIncrementalSeats() /** * Sets incremental_seats + * * @param string $incremental_seats Reserved: TBD + * * @return $this */ public function setIncrementalSeats($incremental_seats) @@ -416,6 +519,7 @@ public function setIncrementalSeats($incremental_seats) /** * Gets is_downgrade + * * @return string */ public function getIsDowngrade() @@ -425,7 +529,9 @@ public function getIsDowngrade() /** * Sets is_downgrade + * * @param string $is_downgrade + * * @return $this */ public function setIsDowngrade($is_downgrade) @@ -437,6 +543,7 @@ public function setIsDowngrade($is_downgrade) /** * Gets other_discount_percent + * * @return string */ public function getOtherDiscountPercent() @@ -446,7 +553,9 @@ public function getOtherDiscountPercent() /** * Sets other_discount_percent + * * @param string $other_discount_percent Any other percentage discount for the plan. + * * @return $this */ public function setOtherDiscountPercent($other_discount_percent) @@ -458,6 +567,7 @@ public function setOtherDiscountPercent($other_discount_percent) /** * Gets payment_cycle + * * @return string */ public function getPaymentCycle() @@ -467,7 +577,9 @@ public function getPaymentCycle() /** * Sets payment_cycle + * * @param string $payment_cycle + * * @return $this */ public function setPaymentCycle($payment_cycle) @@ -479,6 +591,7 @@ public function setPaymentCycle($payment_cycle) /** * Gets payment_method + * * @return string */ public function getPaymentMethod() @@ -488,7 +601,9 @@ public function getPaymentMethod() /** * Sets payment_method + * * @param string $payment_method The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. + * * @return $this */ public function setPaymentMethod($payment_method) @@ -500,6 +615,7 @@ public function setPaymentMethod($payment_method) /** * Gets per_seat_price + * * @return string */ public function getPerSeatPrice() @@ -509,7 +625,9 @@ public function getPerSeatPrice() /** * Sets per_seat_price + * * @param string $per_seat_price + * * @return $this */ public function setPerSeatPrice($per_seat_price) @@ -521,6 +639,7 @@ public function setPerSeatPrice($per_seat_price) /** * Gets plan_classification + * * @return string */ public function getPlanClassification() @@ -530,7 +649,9 @@ public function getPlanClassification() /** * Sets plan_classification + * * @param string $plan_classification Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. + * * @return $this */ public function setPlanClassification($plan_classification) @@ -542,6 +663,7 @@ public function setPlanClassification($plan_classification) /** * Gets plan_feature_sets + * * @return \DocuSign\eSign\Model\FeatureSet[] */ public function getPlanFeatureSets() @@ -551,7 +673,9 @@ public function getPlanFeatureSets() /** * Sets plan_feature_sets + * * @param \DocuSign\eSign\Model\FeatureSet[] $plan_feature_sets A complex type that sets the feature sets for the account. It contains the following information (all string content): * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). * featureSetId - A unique ID for the feature set. * fixedFee - A one-time fee associated with the plan (when isEnabled=true). * isActive - Specifies whether the feature set is actively set as part of the plan. * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. * name - The name of the feature set. * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). + * * @return $this */ public function setPlanFeatureSets($plan_feature_sets) @@ -563,6 +687,7 @@ public function setPlanFeatureSets($plan_feature_sets) /** * Gets plan_id + * * @return string */ public function getPlanId() @@ -572,7 +697,9 @@ public function getPlanId() /** * Sets plan_id + * * @param string $plan_id + * * @return $this */ public function setPlanId($plan_id) @@ -584,6 +711,7 @@ public function setPlanId($plan_id) /** * Gets plan_name + * * @return string */ public function getPlanName() @@ -593,7 +721,9 @@ public function getPlanName() /** * Sets plan_name + * * @param string $plan_name The name of the Billing Plan. + * * @return $this */ public function setPlanName($plan_name) @@ -605,6 +735,7 @@ public function setPlanName($plan_name) /** * Gets renewal_status + * * @return string */ public function getRenewalStatus() @@ -614,7 +745,9 @@ public function getRenewalStatus() /** * Sets renewal_status + * * @param string $renewal_status The renewal status for the account. The acceptable values are: * auto: The account automatically renews. * queued_for_close: Account will be closed at the billingPeriodEndDate. * queued_for_downgrade: Account will be downgraded at the billingPeriodEndDate. + * * @return $this */ public function setRenewalStatus($renewal_status) @@ -626,6 +759,7 @@ public function setRenewalStatus($renewal_status) /** * Gets seat_discounts + * * @return \DocuSign\eSign\Model\SeatDiscount[] */ public function getSeatDiscounts() @@ -635,7 +769,9 @@ public function getSeatDiscounts() /** * Sets seat_discounts + * * @param \DocuSign\eSign\Model\SeatDiscount[] $seat_discounts A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. + * * @return $this */ public function setSeatDiscounts($seat_discounts) @@ -647,6 +783,7 @@ public function setSeatDiscounts($seat_discounts) /** * Gets support_incident_fee + * * @return string */ public function getSupportIncidentFee() @@ -656,7 +793,9 @@ public function getSupportIncidentFee() /** * Sets support_incident_fee + * * @param string $support_incident_fee The support incident fee charged for each support incident. + * * @return $this */ public function setSupportIncidentFee($support_incident_fee) @@ -668,6 +807,7 @@ public function setSupportIncidentFee($support_incident_fee) /** * Gets support_plan_fee + * * @return string */ public function getSupportPlanFee() @@ -677,7 +817,9 @@ public function getSupportPlanFee() /** * Sets support_plan_fee + * * @param string $support_plan_fee The support plan fee charged for this plan. + * * @return $this */ public function setSupportPlanFee($support_plan_fee) @@ -688,7 +830,9 @@ public function setSupportPlanFee($support_plan_fee) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -698,7 +842,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -708,8 +854,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -723,7 +871,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -733,16 +883,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountBillingPlanResponse.php b/src/Model/AccountBillingPlanResponse.php index 26e65c33..01a39e1c 100644 --- a/src/Model/AccountBillingPlanResponse.php +++ b/src/Model/AccountBillingPlanResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountBillingPlanResponse Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountBillingPlanResponse implements ArrayAccess +class AccountBillingPlanResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountBillingPlanResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -67,13 +70,48 @@ class AccountBillingPlanResponse implements ArrayAccess 'successor_plans' => '\DocuSign\eSign\Model\BillingPlan[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'billing_address' => null, + 'billing_address_is_credit_card_address' => null, + 'billing_plan' => null, + 'credit_card_information' => null, + 'direct_debit_processor_information' => null, + 'downgrade_plan_information' => null, + 'payment_method' => null, + 'payment_processor_information' => null, + 'referral_information' => null, + 'successor_plans' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -89,9 +127,9 @@ public static function swaggerTypes() 'successor_plans' => 'successorPlans' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -107,9 +145,9 @@ public static function swaggerTypes() 'successor_plans' => 'setSuccessorPlans' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -125,34 +163,63 @@ public static function swaggerTypes() 'successor_plans' => 'getSuccessorPlans' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -169,30 +236,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets billing_address + * * @return \DocuSign\eSign\Model\AccountAddress */ public function getBillingAddress() @@ -202,7 +271,9 @@ public function getBillingAddress() /** * Sets billing_address - * @param \DocuSign\eSign\Model\AccountAddress $billing_address + * + * @param \DocuSign\eSign\Model\AccountAddress $billing_address billing_address + * * @return $this */ public function setBillingAddress($billing_address) @@ -214,6 +285,7 @@ public function setBillingAddress($billing_address) /** * Gets billing_address_is_credit_card_address + * * @return string */ public function getBillingAddressIsCreditCardAddress() @@ -223,7 +295,9 @@ public function getBillingAddressIsCreditCardAddress() /** * Sets billing_address_is_credit_card_address + * * @param string $billing_address_is_credit_card_address When set to **true**, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different. + * * @return $this */ public function setBillingAddressIsCreditCardAddress($billing_address_is_credit_card_address) @@ -235,6 +309,7 @@ public function setBillingAddressIsCreditCardAddress($billing_address_is_credit_ /** * Gets billing_plan + * * @return \DocuSign\eSign\Model\AccountBillingPlan */ public function getBillingPlan() @@ -244,7 +319,9 @@ public function getBillingPlan() /** * Sets billing_plan - * @param \DocuSign\eSign\Model\AccountBillingPlan $billing_plan + * + * @param \DocuSign\eSign\Model\AccountBillingPlan $billing_plan billing_plan + * * @return $this */ public function setBillingPlan($billing_plan) @@ -256,6 +333,7 @@ public function setBillingPlan($billing_plan) /** * Gets credit_card_information + * * @return \DocuSign\eSign\Model\CreditCardInformation */ public function getCreditCardInformation() @@ -265,7 +343,9 @@ public function getCreditCardInformation() /** * Sets credit_card_information - * @param \DocuSign\eSign\Model\CreditCardInformation $credit_card_information + * + * @param \DocuSign\eSign\Model\CreditCardInformation $credit_card_information credit_card_information + * * @return $this */ public function setCreditCardInformation($credit_card_information) @@ -277,6 +357,7 @@ public function setCreditCardInformation($credit_card_information) /** * Gets direct_debit_processor_information + * * @return \DocuSign\eSign\Model\DirectDebitProcessorInformation */ public function getDirectDebitProcessorInformation() @@ -286,7 +367,9 @@ public function getDirectDebitProcessorInformation() /** * Sets direct_debit_processor_information - * @param \DocuSign\eSign\Model\DirectDebitProcessorInformation $direct_debit_processor_information + * + * @param \DocuSign\eSign\Model\DirectDebitProcessorInformation $direct_debit_processor_information direct_debit_processor_information + * * @return $this */ public function setDirectDebitProcessorInformation($direct_debit_processor_information) @@ -298,6 +381,7 @@ public function setDirectDebitProcessorInformation($direct_debit_processor_infor /** * Gets downgrade_plan_information + * * @return \DocuSign\eSign\Model\DowngradePlanUpdateResponse */ public function getDowngradePlanInformation() @@ -307,7 +391,9 @@ public function getDowngradePlanInformation() /** * Sets downgrade_plan_information - * @param \DocuSign\eSign\Model\DowngradePlanUpdateResponse $downgrade_plan_information + * + * @param \DocuSign\eSign\Model\DowngradePlanUpdateResponse $downgrade_plan_information downgrade_plan_information + * * @return $this */ public function setDowngradePlanInformation($downgrade_plan_information) @@ -319,6 +405,7 @@ public function setDowngradePlanInformation($downgrade_plan_information) /** * Gets payment_method + * * @return string */ public function getPaymentMethod() @@ -328,7 +415,9 @@ public function getPaymentMethod() /** * Sets payment_method + * * @param string $payment_method + * * @return $this */ public function setPaymentMethod($payment_method) @@ -340,6 +429,7 @@ public function setPaymentMethod($payment_method) /** * Gets payment_processor_information + * * @return \DocuSign\eSign\Model\PaymentProcessorInformation */ public function getPaymentProcessorInformation() @@ -349,7 +439,9 @@ public function getPaymentProcessorInformation() /** * Sets payment_processor_information - * @param \DocuSign\eSign\Model\PaymentProcessorInformation $payment_processor_information + * + * @param \DocuSign\eSign\Model\PaymentProcessorInformation $payment_processor_information payment_processor_information + * * @return $this */ public function setPaymentProcessorInformation($payment_processor_information) @@ -361,6 +453,7 @@ public function setPaymentProcessorInformation($payment_processor_information) /** * Gets referral_information + * * @return \DocuSign\eSign\Model\ReferralInformation */ public function getReferralInformation() @@ -370,7 +463,9 @@ public function getReferralInformation() /** * Sets referral_information - * @param \DocuSign\eSign\Model\ReferralInformation $referral_information + * + * @param \DocuSign\eSign\Model\ReferralInformation $referral_information referral_information + * * @return $this */ public function setReferralInformation($referral_information) @@ -382,6 +477,7 @@ public function setReferralInformation($referral_information) /** * Gets successor_plans + * * @return \DocuSign\eSign\Model\BillingPlan[] */ public function getSuccessorPlans() @@ -391,7 +487,9 @@ public function getSuccessorPlans() /** * Sets successor_plans + * * @param \DocuSign\eSign\Model\BillingPlan[] $successor_plans + * * @return $this */ public function setSuccessorPlans($successor_plans) @@ -402,7 +500,9 @@ public function setSuccessorPlans($successor_plans) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -412,7 +512,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -422,8 +524,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -437,7 +541,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -447,16 +553,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountIdentityInputOption.php b/src/Model/AccountIdentityInputOption.php index a4b19d61..e490bf27 100644 --- a/src/Model/AccountIdentityInputOption.php +++ b/src/Model/AccountIdentityInputOption.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountIdentityInputOption Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountIdentityInputOption implements ArrayAccess +class AccountIdentityInputOption implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountIdentityInputOption'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class AccountIdentityInputOption implements ArrayAccess 'value_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'is_required' => null, + 'option_name' => null, + 'value_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'value_type' => 'valueType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'value_type' => 'setValueType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'value_type' => 'getValueType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets is_required + * * @return bool */ public function getIsRequired() @@ -166,7 +228,9 @@ public function getIsRequired() /** * Sets is_required + * * @param bool $is_required + * * @return $this */ public function setIsRequired($is_required) @@ -178,6 +242,7 @@ public function setIsRequired($is_required) /** * Gets option_name + * * @return string */ public function getOptionName() @@ -187,7 +252,9 @@ public function getOptionName() /** * Sets option_name + * * @param string $option_name + * * @return $this */ public function setOptionName($option_name) @@ -199,6 +266,7 @@ public function setOptionName($option_name) /** * Gets value_type + * * @return string */ public function getValueType() @@ -208,7 +276,9 @@ public function getValueType() /** * Sets value_type + * * @param string $value_type + * * @return $this */ public function setValueType($value_type) @@ -219,7 +289,9 @@ public function setValueType($value_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountIdentityVerificationResponse.php b/src/Model/AccountIdentityVerificationResponse.php index b86872ab..5a88f404 100644 --- a/src/Model/AccountIdentityVerificationResponse.php +++ b/src/Model/AccountIdentityVerificationResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountIdentityVerificationResponse Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountIdentityVerificationResponse implements ArrayAccess +class AccountIdentityVerificationResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountIdentityVerificationResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'identity_verification' => '\DocuSign\eSign\Model\AccountIdentityVerificationWorkflow[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'identity_verification' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ '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' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\AccountIdentityVerificationWorkflow[] */ public function getIdentityVerification() @@ -156,7 +216,9 @@ public function getIdentityVerification() /** * Sets identity_verification + * * @param \DocuSign\eSign\Model\AccountIdentityVerificationWorkflow[] $identity_verification + * * @return $this */ public function setIdentityVerification($identity_verification) @@ -167,7 +229,9 @@ public function setIdentityVerification($identity_verification) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountIdentityVerificationStep.php b/src/Model/AccountIdentityVerificationStep.php index db04a4a3..e9189ef9 100644 --- a/src/Model/AccountIdentityVerificationStep.php +++ b/src/Model/AccountIdentityVerificationStep.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountIdentityVerificationStep Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountIdentityVerificationStep implements ArrayAccess +class AccountIdentityVerificationStep implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountIdentityVerificationStep'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class AccountIdentityVerificationStep implements ArrayAccess 'type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'name' => null, + 'type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'type' => 'type' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'type' => 'setType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'type' => 'getType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets name + * * @return string */ public function getName() @@ -161,7 +222,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -173,6 +236,7 @@ public function setName($name) /** * Gets type + * * @return string */ public function getType() @@ -182,7 +246,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -193,7 +259,9 @@ public function setType($type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountIdentityVerificationWorkflow.php b/src/Model/AccountIdentityVerificationWorkflow.php index 1a5bcc44..dae51e83 100644 --- a/src/Model/AccountIdentityVerificationWorkflow.php +++ b/src/Model/AccountIdentityVerificationWorkflow.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountIdentityVerificationWorkflow Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountIdentityVerificationWorkflow implements ArrayAccess +class AccountIdentityVerificationWorkflow implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountIdentityVerificationWorkflow'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class AccountIdentityVerificationWorkflow implements ArrayAccess 'workflow_resource_key' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'default_description' => null, + 'default_name' => null, + 'input_options' => null, + 'signature_provider' => null, + 'steps' => null, + 'workflow_id' => null, + 'workflow_resource_key' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'workflow_resource_key' => 'workflowResourceKey' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'workflow_resource_key' => 'setWorkflowResourceKey' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'workflow_resource_key' => 'getWorkflowResourceKey' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets default_description + * * @return string */ public function getDefaultDescription() @@ -186,7 +252,9 @@ public function getDefaultDescription() /** * Sets default_description + * * @param string $default_description + * * @return $this */ public function setDefaultDescription($default_description) @@ -198,6 +266,7 @@ public function setDefaultDescription($default_description) /** * Gets default_name + * * @return string */ public function getDefaultName() @@ -207,7 +276,9 @@ public function getDefaultName() /** * Sets default_name + * * @param string $default_name + * * @return $this */ public function setDefaultName($default_name) @@ -219,6 +290,7 @@ public function setDefaultName($default_name) /** * Gets input_options + * * @return \DocuSign\eSign\Model\AccountIdentityInputOption[] */ public function getInputOptions() @@ -228,7 +300,9 @@ public function getInputOptions() /** * Sets input_options + * * @param \DocuSign\eSign\Model\AccountIdentityInputOption[] $input_options + * * @return $this */ public function setInputOptions($input_options) @@ -240,6 +314,7 @@ public function setInputOptions($input_options) /** * Gets signature_provider + * * @return \DocuSign\eSign\Model\AccountSignatureProvider */ public function getSignatureProvider() @@ -249,7 +324,9 @@ public function getSignatureProvider() /** * Sets signature_provider - * @param \DocuSign\eSign\Model\AccountSignatureProvider $signature_provider + * + * @param \DocuSign\eSign\Model\AccountSignatureProvider $signature_provider signature_provider + * * @return $this */ public function setSignatureProvider($signature_provider) @@ -261,6 +338,7 @@ public function setSignatureProvider($signature_provider) /** * Gets steps + * * @return \DocuSign\eSign\Model\AccountIdentityVerificationStep[] */ public function getSteps() @@ -270,7 +348,9 @@ public function getSteps() /** * Sets steps + * * @param \DocuSign\eSign\Model\AccountIdentityVerificationStep[] $steps + * * @return $this */ public function setSteps($steps) @@ -282,6 +362,7 @@ public function setSteps($steps) /** * Gets workflow_id + * * @return string */ public function getWorkflowId() @@ -291,7 +372,9 @@ public function getWorkflowId() /** * Sets workflow_id + * * @param string $workflow_id + * * @return $this */ public function setWorkflowId($workflow_id) @@ -303,6 +386,7 @@ public function setWorkflowId($workflow_id) /** * Gets workflow_resource_key + * * @return string */ public function getWorkflowResourceKey() @@ -312,7 +396,9 @@ public function getWorkflowResourceKey() /** * Sets workflow_resource_key + * * @param string $workflow_resource_key + * * @return $this */ public function setWorkflowResourceKey($workflow_resource_key) @@ -323,7 +409,9 @@ public function setWorkflowResourceKey($workflow_resource_key) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountInformation.php b/src/Model/AccountInformation.php index 239fbf99..bec3c771 100644 --- a/src/Model/AccountInformation.php +++ b/src/Model/AccountInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountInformation Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountInformation implements ArrayAccess +class AccountInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -91,13 +94,72 @@ class AccountInformation implements ArrayAccess 'suspension_status' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_id_guid' => null, + 'account_name' => null, + 'account_settings' => null, + 'allow_transaction_rooms' => null, + 'billing_period_days_remaining' => null, + 'billing_period_end_date' => null, + 'billing_period_envelopes_allowed' => null, + 'billing_period_envelopes_sent' => null, + 'billing_period_start_date' => null, + 'billing_profile' => null, + 'can_upgrade' => null, + 'connect_permission' => null, + 'created_date' => null, + 'currency_code' => null, + 'current_plan_id' => null, + 'distributor_code' => null, + 'docu_sign_landing_url' => null, + 'dss_values' => null, + 'envelope_sending_blocked' => null, + 'envelope_unit_price' => null, + 'external_account_id' => null, + 'forgotten_password_questions_count' => null, + 'is_downgrade' => null, + 'payment_method' => null, + 'plan_classification' => null, + 'plan_end_date' => null, + 'plan_name' => null, + 'plan_start_date' => null, + 'recipient_domains' => null, + 'seats_allowed' => null, + 'seats_in_use' => null, + 'status21_cfr_part11' => null, + 'suspension_date' => null, + 'suspension_status' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -137,9 +199,9 @@ public static function swaggerTypes() 'suspension_status' => 'suspensionStatus' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -179,9 +241,9 @@ public static function swaggerTypes() 'suspension_status' => 'setSuspensionStatus' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -221,34 +283,63 @@ public static function swaggerTypes() 'suspension_status' => 'getSuspensionStatus' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -289,30 +380,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_id_guid + * * @return string */ public function getAccountIdGuid() @@ -322,7 +415,9 @@ public function getAccountIdGuid() /** * Sets account_id_guid + * * @param string $account_id_guid The GUID associated with the account ID. + * * @return $this */ public function setAccountIdGuid($account_id_guid) @@ -334,6 +429,7 @@ public function setAccountIdGuid($account_id_guid) /** * Gets account_name + * * @return string */ public function getAccountName() @@ -343,7 +439,9 @@ public function getAccountName() /** * Sets account_name + * * @param string $account_name The name of the current account. + * * @return $this */ public function setAccountName($account_name) @@ -355,6 +453,7 @@ public function setAccountName($account_name) /** * Gets account_settings + * * @return \DocuSign\eSign\Model\AccountSettingsInformation */ public function getAccountSettings() @@ -364,7 +463,9 @@ public function getAccountSettings() /** * Sets account_settings - * @param \DocuSign\eSign\Model\AccountSettingsInformation $account_settings + * + * @param \DocuSign\eSign\Model\AccountSettingsInformation $account_settings account_settings + * * @return $this */ public function setAccountSettings($account_settings) @@ -376,6 +477,7 @@ public function setAccountSettings($account_settings) /** * Gets allow_transaction_rooms + * * @return string */ public function getAllowTransactionRooms() @@ -385,7 +487,9 @@ public function getAllowTransactionRooms() /** * Sets allow_transaction_rooms + * * @param string $allow_transaction_rooms When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled. + * * @return $this */ public function setAllowTransactionRooms($allow_transaction_rooms) @@ -397,6 +501,7 @@ public function setAllowTransactionRooms($allow_transaction_rooms) /** * Gets billing_period_days_remaining + * * @return string */ public function getBillingPeriodDaysRemaining() @@ -406,7 +511,9 @@ public function getBillingPeriodDaysRemaining() /** * Sets billing_period_days_remaining + * * @param string $billing_period_days_remaining Reserved: TBD + * * @return $this */ public function setBillingPeriodDaysRemaining($billing_period_days_remaining) @@ -418,6 +525,7 @@ public function setBillingPeriodDaysRemaining($billing_period_days_remaining) /** * Gets billing_period_end_date + * * @return string */ public function getBillingPeriodEndDate() @@ -427,7 +535,9 @@ public function getBillingPeriodEndDate() /** * Sets billing_period_end_date + * * @param string $billing_period_end_date Reserved: TBD + * * @return $this */ public function setBillingPeriodEndDate($billing_period_end_date) @@ -439,6 +549,7 @@ public function setBillingPeriodEndDate($billing_period_end_date) /** * Gets billing_period_envelopes_allowed + * * @return string */ public function getBillingPeriodEnvelopesAllowed() @@ -448,7 +559,9 @@ public function getBillingPeriodEnvelopesAllowed() /** * Sets billing_period_envelopes_allowed + * * @param string $billing_period_envelopes_allowed Reserved: TBD + * * @return $this */ public function setBillingPeriodEnvelopesAllowed($billing_period_envelopes_allowed) @@ -460,6 +573,7 @@ public function setBillingPeriodEnvelopesAllowed($billing_period_envelopes_allow /** * Gets billing_period_envelopes_sent + * * @return string */ public function getBillingPeriodEnvelopesSent() @@ -469,7 +583,9 @@ public function getBillingPeriodEnvelopesSent() /** * Sets billing_period_envelopes_sent + * * @param string $billing_period_envelopes_sent Reserved: TBD + * * @return $this */ public function setBillingPeriodEnvelopesSent($billing_period_envelopes_sent) @@ -481,6 +597,7 @@ public function setBillingPeriodEnvelopesSent($billing_period_envelopes_sent) /** * Gets billing_period_start_date + * * @return string */ public function getBillingPeriodStartDate() @@ -490,7 +607,9 @@ public function getBillingPeriodStartDate() /** * Sets billing_period_start_date + * * @param string $billing_period_start_date Reserved: TBD + * * @return $this */ public function setBillingPeriodStartDate($billing_period_start_date) @@ -502,6 +621,7 @@ public function setBillingPeriodStartDate($billing_period_start_date) /** * Gets billing_profile + * * @return string */ public function getBillingProfile() @@ -511,7 +631,9 @@ public function getBillingProfile() /** * Sets billing_profile + * * @param string $billing_profile Reserved: TBD + * * @return $this */ public function setBillingProfile($billing_profile) @@ -523,6 +645,7 @@ public function setBillingProfile($billing_profile) /** * Gets can_upgrade + * * @return string */ public function getCanUpgrade() @@ -532,7 +655,9 @@ public function getCanUpgrade() /** * Sets can_upgrade + * * @param string $can_upgrade When set to **true**, specifies that you can upgrade the account through the API. + * * @return $this */ public function setCanUpgrade($can_upgrade) @@ -544,6 +669,7 @@ public function setCanUpgrade($can_upgrade) /** * Gets connect_permission + * * @return string */ public function getConnectPermission() @@ -553,7 +679,9 @@ public function getConnectPermission() /** * Sets connect_permission + * * @param string $connect_permission + * * @return $this */ public function setConnectPermission($connect_permission) @@ -565,6 +693,7 @@ public function setConnectPermission($connect_permission) /** * Gets created_date + * * @return string */ public function getCreatedDate() @@ -574,7 +703,9 @@ public function getCreatedDate() /** * Sets created_date + * * @param string $created_date + * * @return $this */ public function setCreatedDate($created_date) @@ -586,6 +717,7 @@ public function setCreatedDate($created_date) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -595,7 +727,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code Specifies the ISO currency code for the account. + * * @return $this */ public function setCurrencyCode($currency_code) @@ -607,6 +741,7 @@ public function setCurrencyCode($currency_code) /** * Gets current_plan_id + * * @return string */ public function getCurrentPlanId() @@ -616,7 +751,9 @@ public function getCurrentPlanId() /** * Sets current_plan_id + * * @param string $current_plan_id Identifies the plan that was used create this account. + * * @return $this */ public function setCurrentPlanId($current_plan_id) @@ -628,6 +765,7 @@ public function setCurrentPlanId($current_plan_id) /** * Gets distributor_code + * * @return string */ public function getDistributorCode() @@ -637,7 +775,9 @@ public function getDistributorCode() /** * Sets distributor_code + * * @param string $distributor_code The code that identifies the billing plan groups and plans for the new account. + * * @return $this */ public function setDistributorCode($distributor_code) @@ -649,6 +789,7 @@ public function setDistributorCode($distributor_code) /** * Gets docu_sign_landing_url + * * @return string */ public function getDocuSignLandingUrl() @@ -658,7 +799,9 @@ public function getDocuSignLandingUrl() /** * Sets docu_sign_landing_url + * * @param string $docu_sign_landing_url + * * @return $this */ public function setDocuSignLandingUrl($docu_sign_landing_url) @@ -670,6 +813,7 @@ public function setDocuSignLandingUrl($docu_sign_landing_url) /** * Gets dss_values + * * @return map[string,string] */ public function getDssValues() @@ -679,7 +823,9 @@ public function getDssValues() /** * Sets dss_values + * * @param map[string,string] $dss_values + * * @return $this */ public function setDssValues($dss_values) @@ -691,6 +837,7 @@ public function setDssValues($dss_values) /** * Gets envelope_sending_blocked + * * @return string */ public function getEnvelopeSendingBlocked() @@ -700,7 +847,9 @@ public function getEnvelopeSendingBlocked() /** * Sets envelope_sending_blocked + * * @param string $envelope_sending_blocked + * * @return $this */ public function setEnvelopeSendingBlocked($envelope_sending_blocked) @@ -712,6 +861,7 @@ public function setEnvelopeSendingBlocked($envelope_sending_blocked) /** * Gets envelope_unit_price + * * @return string */ public function getEnvelopeUnitPrice() @@ -721,7 +871,9 @@ public function getEnvelopeUnitPrice() /** * Sets envelope_unit_price + * * @param string $envelope_unit_price + * * @return $this */ public function setEnvelopeUnitPrice($envelope_unit_price) @@ -733,6 +885,7 @@ public function setEnvelopeUnitPrice($envelope_unit_price) /** * Gets external_account_id + * * @return string */ public function getExternalAccountId() @@ -742,7 +895,9 @@ public function getExternalAccountId() /** * Sets external_account_id + * * @param string $external_account_id + * * @return $this */ public function setExternalAccountId($external_account_id) @@ -754,6 +909,7 @@ public function setExternalAccountId($external_account_id) /** * Gets forgotten_password_questions_count + * * @return string */ public function getForgottenPasswordQuestionsCount() @@ -763,7 +919,9 @@ public function getForgottenPasswordQuestionsCount() /** * Sets forgotten_password_questions_count + * * @param string $forgotten_password_questions_count A complex element that contains up to four Question/Answer pairs for forgotten password information for a user. + * * @return $this */ public function setForgottenPasswordQuestionsCount($forgotten_password_questions_count) @@ -775,6 +933,7 @@ public function setForgottenPasswordQuestionsCount($forgotten_password_questions /** * Gets is_downgrade + * * @return string */ public function getIsDowngrade() @@ -784,7 +943,9 @@ public function getIsDowngrade() /** * Sets is_downgrade + * * @param string $is_downgrade + * * @return $this */ public function setIsDowngrade($is_downgrade) @@ -796,6 +957,7 @@ public function setIsDowngrade($is_downgrade) /** * Gets payment_method + * * @return string */ public function getPaymentMethod() @@ -805,7 +967,9 @@ public function getPaymentMethod() /** * Sets payment_method + * * @param string $payment_method + * * @return $this */ public function setPaymentMethod($payment_method) @@ -817,6 +981,7 @@ public function setPaymentMethod($payment_method) /** * Gets plan_classification + * * @return string */ public function getPlanClassification() @@ -826,7 +991,9 @@ public function getPlanClassification() /** * Sets plan_classification + * * @param string $plan_classification Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. + * * @return $this */ public function setPlanClassification($plan_classification) @@ -838,6 +1005,7 @@ public function setPlanClassification($plan_classification) /** * Gets plan_end_date + * * @return string */ public function getPlanEndDate() @@ -847,7 +1015,9 @@ public function getPlanEndDate() /** * Sets plan_end_date + * * @param string $plan_end_date The date that the current plan will end. + * * @return $this */ public function setPlanEndDate($plan_end_date) @@ -859,6 +1029,7 @@ public function setPlanEndDate($plan_end_date) /** * Gets plan_name + * * @return string */ public function getPlanName() @@ -868,7 +1039,9 @@ public function getPlanName() /** * Sets plan_name + * * @param string $plan_name The name of the Billing Plan. + * * @return $this */ public function setPlanName($plan_name) @@ -880,6 +1053,7 @@ public function setPlanName($plan_name) /** * Gets plan_start_date + * * @return string */ public function getPlanStartDate() @@ -889,7 +1063,9 @@ public function getPlanStartDate() /** * Sets plan_start_date + * * @param string $plan_start_date The date that the Account started using the current plan. + * * @return $this */ public function setPlanStartDate($plan_start_date) @@ -901,6 +1077,7 @@ public function setPlanStartDate($plan_start_date) /** * Gets recipient_domains + * * @return \DocuSign\eSign\Model\RecipientDomain[] */ public function getRecipientDomains() @@ -910,7 +1087,9 @@ public function getRecipientDomains() /** * Sets recipient_domains + * * @param \DocuSign\eSign\Model\RecipientDomain[] $recipient_domains + * * @return $this */ public function setRecipientDomains($recipient_domains) @@ -922,6 +1101,7 @@ public function setRecipientDomains($recipient_domains) /** * Gets seats_allowed + * * @return string */ public function getSeatsAllowed() @@ -931,7 +1111,9 @@ public function getSeatsAllowed() /** * Sets seats_allowed + * * @param string $seats_allowed + * * @return $this */ public function setSeatsAllowed($seats_allowed) @@ -943,6 +1125,7 @@ public function setSeatsAllowed($seats_allowed) /** * Gets seats_in_use + * * @return string */ public function getSeatsInUse() @@ -952,7 +1135,9 @@ public function getSeatsInUse() /** * Sets seats_in_use + * * @param string $seats_in_use + * * @return $this */ public function setSeatsInUse($seats_in_use) @@ -964,6 +1149,7 @@ public function setSeatsInUse($seats_in_use) /** * Gets status21_cfr_part11 + * * @return string */ public function getStatus21CfrPart11() @@ -973,7 +1159,9 @@ public function getStatus21CfrPart11() /** * Sets status21_cfr_part11 + * * @param string $status21_cfr_part11 + * * @return $this */ public function setStatus21CfrPart11($status21_cfr_part11) @@ -985,6 +1173,7 @@ public function setStatus21CfrPart11($status21_cfr_part11) /** * Gets suspension_date + * * @return string */ public function getSuspensionDate() @@ -994,7 +1183,9 @@ public function getSuspensionDate() /** * Sets suspension_date + * * @param string $suspension_date + * * @return $this */ public function setSuspensionDate($suspension_date) @@ -1006,6 +1197,7 @@ public function setSuspensionDate($suspension_date) /** * Gets suspension_status + * * @return string */ public function getSuspensionStatus() @@ -1015,7 +1207,9 @@ public function getSuspensionStatus() /** * Sets suspension_status + * * @param string $suspension_status + * * @return $this */ public function setSuspensionStatus($suspension_status) @@ -1026,7 +1220,9 @@ public function setSuspensionStatus($suspension_status) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1036,7 +1232,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1046,8 +1244,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1061,7 +1261,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1071,16 +1273,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountMinimumPasswordLength.php b/src/Model/AccountMinimumPasswordLength.php index 54c1b7c1..d6e56cc1 100644 --- a/src/Model/AccountMinimumPasswordLength.php +++ b/src/Model/AccountMinimumPasswordLength.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountMinimumPasswordLength Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountMinimumPasswordLength implements ArrayAccess +class AccountMinimumPasswordLength implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountMinimumPasswordLength'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class AccountMinimumPasswordLength implements ArrayAccess 'minimum_length' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'maximum_length' => null, + 'minimum_length' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'minimum_length' => 'minimumLength' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'minimum_length' => 'setMinimumLength' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'minimum_length' => 'getMinimumLength' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets maximum_length + * * @return string */ public function getMaximumLength() @@ -161,7 +222,9 @@ public function getMaximumLength() /** * Sets maximum_length + * * @param string $maximum_length + * * @return $this */ public function setMaximumLength($maximum_length) @@ -173,6 +236,7 @@ public function setMaximumLength($maximum_length) /** * Gets minimum_length + * * @return string */ public function getMinimumLength() @@ -182,7 +246,9 @@ public function getMinimumLength() /** * Sets minimum_length + * * @param string $minimum_length + * * @return $this */ public function setMinimumLength($minimum_length) @@ -193,7 +259,9 @@ public function setMinimumLength($minimum_length) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountNotification.php b/src/Model/AccountNotification.php index 480d8a19..762f7f8c 100644 --- a/src/Model/AccountNotification.php +++ b/src/Model/AccountNotification.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountNotification Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountNotification implements ArrayAccess +class AccountNotification implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountNotification'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class AccountNotification implements ArrayAccess 'user_override_enabled' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'expirations' => null, + 'reminders' => null, + 'user_override_enabled' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'user_override_enabled' => 'userOverrideEnabled' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'user_override_enabled' => 'setUserOverrideEnabled' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'user_override_enabled' => 'getUserOverrideEnabled' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets expirations + * * @return \DocuSign\eSign\Model\Expirations */ public function getExpirations() @@ -166,7 +228,9 @@ public function getExpirations() /** * Sets expirations - * @param \DocuSign\eSign\Model\Expirations $expirations + * + * @param \DocuSign\eSign\Model\Expirations $expirations expirations + * * @return $this */ public function setExpirations($expirations) @@ -178,6 +242,7 @@ public function setExpirations($expirations) /** * Gets reminders + * * @return \DocuSign\eSign\Model\Reminders */ public function getReminders() @@ -187,7 +252,9 @@ public function getReminders() /** * Sets reminders - * @param \DocuSign\eSign\Model\Reminders $reminders + * + * @param \DocuSign\eSign\Model\Reminders $reminders reminders + * * @return $this */ public function setReminders($reminders) @@ -199,6 +266,7 @@ public function setReminders($reminders) /** * Gets user_override_enabled + * * @return string */ public function getUserOverrideEnabled() @@ -208,7 +276,9 @@ public function getUserOverrideEnabled() /** * Sets user_override_enabled + * * @param string $user_override_enabled + * * @return $this */ public function setUserOverrideEnabled($user_override_enabled) @@ -219,7 +289,9 @@ public function setUserOverrideEnabled($user_override_enabled) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountPasswordExpirePasswordDays.php b/src/Model/AccountPasswordExpirePasswordDays.php index 2a8b3311..d8fd70c3 100644 --- a/src/Model/AccountPasswordExpirePasswordDays.php +++ b/src/Model/AccountPasswordExpirePasswordDays.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountPasswordExpirePasswordDays Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountPasswordExpirePasswordDays implements ArrayAccess +class AccountPasswordExpirePasswordDays implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountPasswordExpirePasswordDays'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class AccountPasswordExpirePasswordDays implements ArrayAccess 'minimum_days' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'maximum_days' => null, + 'minimum_days' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'minimum_days' => 'minimumDays' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'minimum_days' => 'setMinimumDays' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'minimum_days' => 'getMinimumDays' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets maximum_days + * * @return string */ public function getMaximumDays() @@ -161,7 +222,9 @@ public function getMaximumDays() /** * Sets maximum_days + * * @param string $maximum_days + * * @return $this */ public function setMaximumDays($maximum_days) @@ -173,6 +236,7 @@ public function setMaximumDays($maximum_days) /** * Gets minimum_days + * * @return string */ public function getMinimumDays() @@ -182,7 +246,9 @@ public function getMinimumDays() /** * Sets minimum_days + * * @param string $minimum_days + * * @return $this */ public function setMinimumDays($minimum_days) @@ -193,7 +259,9 @@ public function setMinimumDays($minimum_days) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountPasswordLockoutDurationMinutes.php b/src/Model/AccountPasswordLockoutDurationMinutes.php index 4f3a8005..7f5ff53a 100644 --- a/src/Model/AccountPasswordLockoutDurationMinutes.php +++ b/src/Model/AccountPasswordLockoutDurationMinutes.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountPasswordLockoutDurationMinutes Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountPasswordLockoutDurationMinutes implements ArrayAccess +class AccountPasswordLockoutDurationMinutes implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountPasswordLockoutDurationMinutes'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class AccountPasswordLockoutDurationMinutes implements ArrayAccess 'minimum_minutes' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'maximum_minutes' => null, + 'minimum_minutes' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'minimum_minutes' => 'minimumMinutes' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'minimum_minutes' => 'setMinimumMinutes' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'minimum_minutes' => 'getMinimumMinutes' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets maximum_minutes + * * @return string */ public function getMaximumMinutes() @@ -161,7 +222,9 @@ public function getMaximumMinutes() /** * Sets maximum_minutes + * * @param string $maximum_minutes + * * @return $this */ public function setMaximumMinutes($maximum_minutes) @@ -173,6 +236,7 @@ public function setMaximumMinutes($maximum_minutes) /** * Gets minimum_minutes + * * @return string */ public function getMinimumMinutes() @@ -182,7 +246,9 @@ public function getMinimumMinutes() /** * Sets minimum_minutes + * * @param string $minimum_minutes + * * @return $this */ public function setMinimumMinutes($minimum_minutes) @@ -193,7 +259,9 @@ public function setMinimumMinutes($minimum_minutes) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountPasswordLockoutDurationType.php b/src/Model/AccountPasswordLockoutDurationType.php index ebb2b2cb..85c09433 100644 --- a/src/Model/AccountPasswordLockoutDurationType.php +++ b/src/Model/AccountPasswordLockoutDurationType.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountPasswordLockoutDurationType Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountPasswordLockoutDurationType implements ArrayAccess +class AccountPasswordLockoutDurationType implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountPasswordLockoutDurationType'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'options' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'options' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ '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' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets options + * * @return string[] */ public function getOptions() @@ -156,7 +216,9 @@ public function getOptions() /** * Sets options + * * @param string[] $options + * * @return $this */ public function setOptions($options) @@ -167,7 +229,9 @@ public function setOptions($options) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountPasswordMinimumPasswordAgeDays.php b/src/Model/AccountPasswordMinimumPasswordAgeDays.php index b7eb90f1..f42d0d73 100644 --- a/src/Model/AccountPasswordMinimumPasswordAgeDays.php +++ b/src/Model/AccountPasswordMinimumPasswordAgeDays.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountPasswordMinimumPasswordAgeDays Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountPasswordMinimumPasswordAgeDays implements ArrayAccess +class AccountPasswordMinimumPasswordAgeDays implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountPasswordMinimumPasswordAgeDays'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class AccountPasswordMinimumPasswordAgeDays implements ArrayAccess 'minimum_age' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'maximum_age' => null, + 'minimum_age' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'minimum_age' => 'minimumAge' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'minimum_age' => 'setMinimumAge' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'minimum_age' => 'getMinimumAge' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets maximum_age + * * @return string */ public function getMaximumAge() @@ -161,7 +222,9 @@ public function getMaximumAge() /** * Sets maximum_age + * * @param string $maximum_age + * * @return $this */ public function setMaximumAge($maximum_age) @@ -173,6 +236,7 @@ public function setMaximumAge($maximum_age) /** * Gets minimum_age + * * @return string */ public function getMinimumAge() @@ -182,7 +246,9 @@ public function getMinimumAge() /** * Sets minimum_age + * * @param string $minimum_age + * * @return $this */ public function setMinimumAge($minimum_age) @@ -193,7 +259,9 @@ public function setMinimumAge($minimum_age) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountPasswordQuestionsRequired.php b/src/Model/AccountPasswordQuestionsRequired.php index 30f063a2..fc1d02bb 100644 --- a/src/Model/AccountPasswordQuestionsRequired.php +++ b/src/Model/AccountPasswordQuestionsRequired.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountPasswordQuestionsRequired Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountPasswordQuestionsRequired implements ArrayAccess +class AccountPasswordQuestionsRequired implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountPasswordQuestionsRequired'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class AccountPasswordQuestionsRequired implements ArrayAccess 'minimum_questions' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'maximum_questions' => null, + 'minimum_questions' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'minimum_questions' => 'minimumQuestions' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'minimum_questions' => 'setMinimumQuestions' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'minimum_questions' => 'getMinimumQuestions' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets maximum_questions + * * @return string */ public function getMaximumQuestions() @@ -161,7 +222,9 @@ public function getMaximumQuestions() /** * Sets maximum_questions + * * @param string $maximum_questions + * * @return $this */ public function setMaximumQuestions($maximum_questions) @@ -173,6 +236,7 @@ public function setMaximumQuestions($maximum_questions) /** * Gets minimum_questions + * * @return string */ public function getMinimumQuestions() @@ -182,7 +246,9 @@ public function getMinimumQuestions() /** * Sets minimum_questions + * * @param string $minimum_questions + * * @return $this */ public function setMinimumQuestions($minimum_questions) @@ -193,7 +259,9 @@ public function setMinimumQuestions($minimum_questions) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountPasswordRules.php b/src/Model/AccountPasswordRules.php index a4d0918a..712396ca 100644 --- a/src/Model/AccountPasswordRules.php +++ b/src/Model/AccountPasswordRules.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountPasswordRules Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountPasswordRules implements ArrayAccess +class AccountPasswordRules implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountPasswordRules'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -76,13 +79,58 @@ class AccountPasswordRules implements ArrayAccess 'questions_required_metadata' => '\DocuSign\eSign\Model\AccountPasswordQuestionsRequired' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'expire_password' => null, + 'expire_password_days' => null, + 'expire_password_days_metadata' => null, + 'lockout_duration_minutes' => null, + 'lockout_duration_minutes_metadata' => null, + 'lockout_duration_type' => null, + 'lockout_duration_type_metadata' => null, + 'minimum_password_age_days' => null, + 'minimum_password_age_days_metadata' => null, + 'minimum_password_length' => null, + 'minimum_password_length_metadata' => null, + 'password_include_digit' => null, + 'password_include_digit_or_special_character' => null, + 'password_include_lower_case' => null, + 'password_include_special_character' => null, + 'password_include_upper_case' => null, + 'password_strength_type' => null, + 'password_strength_type_metadata' => null, + 'questions_required' => null, + 'questions_required_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -108,9 +156,9 @@ public static function swaggerTypes() 'questions_required_metadata' => 'questionsRequiredMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -136,9 +184,9 @@ public static function swaggerTypes() 'questions_required_metadata' => 'setQuestionsRequiredMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -164,34 +212,63 @@ public static function swaggerTypes() 'questions_required_metadata' => 'getQuestionsRequiredMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -218,30 +295,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets expire_password + * * @return string */ public function getExpirePassword() @@ -251,7 +330,9 @@ public function getExpirePassword() /** * Sets expire_password + * * @param string $expire_password + * * @return $this */ public function setExpirePassword($expire_password) @@ -263,6 +344,7 @@ public function setExpirePassword($expire_password) /** * Gets expire_password_days + * * @return string */ public function getExpirePasswordDays() @@ -272,7 +354,9 @@ public function getExpirePasswordDays() /** * Sets expire_password_days + * * @param string $expire_password_days + * * @return $this */ public function setExpirePasswordDays($expire_password_days) @@ -284,6 +368,7 @@ public function setExpirePasswordDays($expire_password_days) /** * Gets expire_password_days_metadata + * * @return \DocuSign\eSign\Model\AccountPasswordExpirePasswordDays */ public function getExpirePasswordDaysMetadata() @@ -293,7 +378,9 @@ public function getExpirePasswordDaysMetadata() /** * Sets expire_password_days_metadata - * @param \DocuSign\eSign\Model\AccountPasswordExpirePasswordDays $expire_password_days_metadata + * + * @param \DocuSign\eSign\Model\AccountPasswordExpirePasswordDays $expire_password_days_metadata expire_password_days_metadata + * * @return $this */ public function setExpirePasswordDaysMetadata($expire_password_days_metadata) @@ -305,6 +392,7 @@ public function setExpirePasswordDaysMetadata($expire_password_days_metadata) /** * Gets lockout_duration_minutes + * * @return string */ public function getLockoutDurationMinutes() @@ -314,7 +402,9 @@ public function getLockoutDurationMinutes() /** * Sets lockout_duration_minutes + * * @param string $lockout_duration_minutes + * * @return $this */ public function setLockoutDurationMinutes($lockout_duration_minutes) @@ -326,6 +416,7 @@ public function setLockoutDurationMinutes($lockout_duration_minutes) /** * Gets lockout_duration_minutes_metadata + * * @return \DocuSign\eSign\Model\AccountPasswordLockoutDurationMinutes */ public function getLockoutDurationMinutesMetadata() @@ -335,7 +426,9 @@ public function getLockoutDurationMinutesMetadata() /** * Sets lockout_duration_minutes_metadata - * @param \DocuSign\eSign\Model\AccountPasswordLockoutDurationMinutes $lockout_duration_minutes_metadata + * + * @param \DocuSign\eSign\Model\AccountPasswordLockoutDurationMinutes $lockout_duration_minutes_metadata lockout_duration_minutes_metadata + * * @return $this */ public function setLockoutDurationMinutesMetadata($lockout_duration_minutes_metadata) @@ -347,6 +440,7 @@ public function setLockoutDurationMinutesMetadata($lockout_duration_minutes_meta /** * Gets lockout_duration_type + * * @return string */ public function getLockoutDurationType() @@ -356,7 +450,9 @@ public function getLockoutDurationType() /** * Sets lockout_duration_type + * * @param string $lockout_duration_type + * * @return $this */ public function setLockoutDurationType($lockout_duration_type) @@ -368,6 +464,7 @@ public function setLockoutDurationType($lockout_duration_type) /** * Gets lockout_duration_type_metadata + * * @return \DocuSign\eSign\Model\AccountPasswordLockoutDurationType */ public function getLockoutDurationTypeMetadata() @@ -377,7 +474,9 @@ public function getLockoutDurationTypeMetadata() /** * Sets lockout_duration_type_metadata - * @param \DocuSign\eSign\Model\AccountPasswordLockoutDurationType $lockout_duration_type_metadata + * + * @param \DocuSign\eSign\Model\AccountPasswordLockoutDurationType $lockout_duration_type_metadata lockout_duration_type_metadata + * * @return $this */ public function setLockoutDurationTypeMetadata($lockout_duration_type_metadata) @@ -389,6 +488,7 @@ public function setLockoutDurationTypeMetadata($lockout_duration_type_metadata) /** * Gets minimum_password_age_days + * * @return string */ public function getMinimumPasswordAgeDays() @@ -398,7 +498,9 @@ public function getMinimumPasswordAgeDays() /** * Sets minimum_password_age_days + * * @param string $minimum_password_age_days + * * @return $this */ public function setMinimumPasswordAgeDays($minimum_password_age_days) @@ -410,6 +512,7 @@ public function setMinimumPasswordAgeDays($minimum_password_age_days) /** * Gets minimum_password_age_days_metadata + * * @return \DocuSign\eSign\Model\AccountPasswordMinimumPasswordAgeDays */ public function getMinimumPasswordAgeDaysMetadata() @@ -419,7 +522,9 @@ public function getMinimumPasswordAgeDaysMetadata() /** * Sets minimum_password_age_days_metadata - * @param \DocuSign\eSign\Model\AccountPasswordMinimumPasswordAgeDays $minimum_password_age_days_metadata + * + * @param \DocuSign\eSign\Model\AccountPasswordMinimumPasswordAgeDays $minimum_password_age_days_metadata minimum_password_age_days_metadata + * * @return $this */ public function setMinimumPasswordAgeDaysMetadata($minimum_password_age_days_metadata) @@ -431,6 +536,7 @@ public function setMinimumPasswordAgeDaysMetadata($minimum_password_age_days_met /** * Gets minimum_password_length + * * @return string */ public function getMinimumPasswordLength() @@ -440,7 +546,9 @@ public function getMinimumPasswordLength() /** * Sets minimum_password_length + * * @param string $minimum_password_length + * * @return $this */ public function setMinimumPasswordLength($minimum_password_length) @@ -452,6 +560,7 @@ public function setMinimumPasswordLength($minimum_password_length) /** * Gets minimum_password_length_metadata + * * @return \DocuSign\eSign\Model\AccountMinimumPasswordLength */ public function getMinimumPasswordLengthMetadata() @@ -461,7 +570,9 @@ public function getMinimumPasswordLengthMetadata() /** * Sets minimum_password_length_metadata - * @param \DocuSign\eSign\Model\AccountMinimumPasswordLength $minimum_password_length_metadata + * + * @param \DocuSign\eSign\Model\AccountMinimumPasswordLength $minimum_password_length_metadata minimum_password_length_metadata + * * @return $this */ public function setMinimumPasswordLengthMetadata($minimum_password_length_metadata) @@ -473,6 +584,7 @@ public function setMinimumPasswordLengthMetadata($minimum_password_length_metada /** * Gets password_include_digit + * * @return string */ public function getPasswordIncludeDigit() @@ -482,7 +594,9 @@ public function getPasswordIncludeDigit() /** * Sets password_include_digit + * * @param string $password_include_digit + * * @return $this */ public function setPasswordIncludeDigit($password_include_digit) @@ -494,6 +608,7 @@ public function setPasswordIncludeDigit($password_include_digit) /** * Gets password_include_digit_or_special_character + * * @return string */ public function getPasswordIncludeDigitOrSpecialCharacter() @@ -503,7 +618,9 @@ public function getPasswordIncludeDigitOrSpecialCharacter() /** * 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) @@ -515,6 +632,7 @@ public function setPasswordIncludeDigitOrSpecialCharacter($password_include_digi /** * Gets password_include_lower_case + * * @return string */ public function getPasswordIncludeLowerCase() @@ -524,7 +642,9 @@ public function getPasswordIncludeLowerCase() /** * Sets password_include_lower_case + * * @param string $password_include_lower_case + * * @return $this */ public function setPasswordIncludeLowerCase($password_include_lower_case) @@ -536,6 +656,7 @@ public function setPasswordIncludeLowerCase($password_include_lower_case) /** * Gets password_include_special_character + * * @return string */ public function getPasswordIncludeSpecialCharacter() @@ -545,7 +666,9 @@ public function getPasswordIncludeSpecialCharacter() /** * Sets password_include_special_character + * * @param string $password_include_special_character + * * @return $this */ public function setPasswordIncludeSpecialCharacter($password_include_special_character) @@ -557,6 +680,7 @@ public function setPasswordIncludeSpecialCharacter($password_include_special_cha /** * Gets password_include_upper_case + * * @return string */ public function getPasswordIncludeUpperCase() @@ -566,7 +690,9 @@ public function getPasswordIncludeUpperCase() /** * Sets password_include_upper_case + * * @param string $password_include_upper_case + * * @return $this */ public function setPasswordIncludeUpperCase($password_include_upper_case) @@ -578,6 +704,7 @@ public function setPasswordIncludeUpperCase($password_include_upper_case) /** * Gets password_strength_type + * * @return string */ public function getPasswordStrengthType() @@ -587,7 +714,9 @@ public function getPasswordStrengthType() /** * Sets password_strength_type + * * @param string $password_strength_type + * * @return $this */ public function setPasswordStrengthType($password_strength_type) @@ -599,6 +728,7 @@ public function setPasswordStrengthType($password_strength_type) /** * Gets password_strength_type_metadata + * * @return \DocuSign\eSign\Model\AccountPasswordStrengthType */ public function getPasswordStrengthTypeMetadata() @@ -608,7 +738,9 @@ public function getPasswordStrengthTypeMetadata() /** * Sets password_strength_type_metadata - * @param \DocuSign\eSign\Model\AccountPasswordStrengthType $password_strength_type_metadata + * + * @param \DocuSign\eSign\Model\AccountPasswordStrengthType $password_strength_type_metadata password_strength_type_metadata + * * @return $this */ public function setPasswordStrengthTypeMetadata($password_strength_type_metadata) @@ -620,6 +752,7 @@ public function setPasswordStrengthTypeMetadata($password_strength_type_metadata /** * Gets questions_required + * * @return string */ public function getQuestionsRequired() @@ -629,7 +762,9 @@ public function getQuestionsRequired() /** * Sets questions_required + * * @param string $questions_required + * * @return $this */ public function setQuestionsRequired($questions_required) @@ -641,6 +776,7 @@ public function setQuestionsRequired($questions_required) /** * Gets questions_required_metadata + * * @return \DocuSign\eSign\Model\AccountPasswordQuestionsRequired */ public function getQuestionsRequiredMetadata() @@ -650,7 +786,9 @@ public function getQuestionsRequiredMetadata() /** * Sets questions_required_metadata - * @param \DocuSign\eSign\Model\AccountPasswordQuestionsRequired $questions_required_metadata + * + * @param \DocuSign\eSign\Model\AccountPasswordQuestionsRequired $questions_required_metadata questions_required_metadata + * * @return $this */ public function setQuestionsRequiredMetadata($questions_required_metadata) @@ -661,7 +799,9 @@ public function setQuestionsRequiredMetadata($questions_required_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -671,7 +811,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -681,8 +823,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -696,7 +840,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -706,16 +852,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountPasswordStrengthType.php b/src/Model/AccountPasswordStrengthType.php index d1313639..826138a0 100644 --- a/src/Model/AccountPasswordStrengthType.php +++ b/src/Model/AccountPasswordStrengthType.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountPasswordStrengthType Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountPasswordStrengthType implements ArrayAccess +class AccountPasswordStrengthType implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountPasswordStrengthType'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'options' => '\DocuSign\eSign\Model\AccountPasswordStrengthTypeOption[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'options' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ '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' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets options + * * @return \DocuSign\eSign\Model\AccountPasswordStrengthTypeOption[] */ public function getOptions() @@ -156,7 +216,9 @@ public function getOptions() /** * Sets options + * * @param \DocuSign\eSign\Model\AccountPasswordStrengthTypeOption[] $options + * * @return $this */ public function setOptions($options) @@ -167,7 +229,9 @@ public function setOptions($options) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountPasswordStrengthTypeOption.php b/src/Model/AccountPasswordStrengthTypeOption.php index 9cb7cd3b..467ab247 100644 --- a/src/Model/AccountPasswordStrengthTypeOption.php +++ b/src/Model/AccountPasswordStrengthTypeOption.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountPasswordStrengthTypeOption Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountPasswordStrengthTypeOption implements ArrayAccess +class AccountPasswordStrengthTypeOption implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountPasswordStrengthTypeOption'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class AccountPasswordStrengthTypeOption implements ArrayAccess 'password_include_upper_case' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'minimum_length' => null, + 'name' => null, + 'password_include_digit' => null, + 'password_include_digit_or_special_character' => null, + 'password_include_lower_case' => null, + 'password_include_special_character' => null, + 'password_include_upper_case' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'password_include_upper_case' => 'passwordIncludeUpperCase' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'password_include_upper_case' => 'setPasswordIncludeUpperCase' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'password_include_upper_case' => 'getPasswordIncludeUpperCase' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets minimum_length + * * @return string */ public function getMinimumLength() @@ -186,7 +252,9 @@ public function getMinimumLength() /** * Sets minimum_length + * * @param string $minimum_length + * * @return $this */ public function setMinimumLength($minimum_length) @@ -198,6 +266,7 @@ public function setMinimumLength($minimum_length) /** * Gets name + * * @return string */ public function getName() @@ -207,7 +276,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -219,6 +290,7 @@ public function setName($name) /** * Gets password_include_digit + * * @return string */ public function getPasswordIncludeDigit() @@ -228,7 +300,9 @@ public function getPasswordIncludeDigit() /** * Sets password_include_digit + * * @param string $password_include_digit + * * @return $this */ public function setPasswordIncludeDigit($password_include_digit) @@ -240,6 +314,7 @@ public function setPasswordIncludeDigit($password_include_digit) /** * Gets password_include_digit_or_special_character + * * @return string */ public function getPasswordIncludeDigitOrSpecialCharacter() @@ -249,7 +324,9 @@ public function getPasswordIncludeDigitOrSpecialCharacter() /** * 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) @@ -261,6 +338,7 @@ public function setPasswordIncludeDigitOrSpecialCharacter($password_include_digi /** * Gets password_include_lower_case + * * @return string */ public function getPasswordIncludeLowerCase() @@ -270,7 +348,9 @@ public function getPasswordIncludeLowerCase() /** * Sets password_include_lower_case + * * @param string $password_include_lower_case + * * @return $this */ public function setPasswordIncludeLowerCase($password_include_lower_case) @@ -282,6 +362,7 @@ public function setPasswordIncludeLowerCase($password_include_lower_case) /** * Gets password_include_special_character + * * @return string */ public function getPasswordIncludeSpecialCharacter() @@ -291,7 +372,9 @@ public function getPasswordIncludeSpecialCharacter() /** * Sets password_include_special_character + * * @param string $password_include_special_character + * * @return $this */ public function setPasswordIncludeSpecialCharacter($password_include_special_character) @@ -303,6 +386,7 @@ public function setPasswordIncludeSpecialCharacter($password_include_special_cha /** * Gets password_include_upper_case + * * @return string */ public function getPasswordIncludeUpperCase() @@ -312,7 +396,9 @@ public function getPasswordIncludeUpperCase() /** * Sets password_include_upper_case + * * @param string $password_include_upper_case + * * @return $this */ public function setPasswordIncludeUpperCase($password_include_upper_case) @@ -323,7 +409,9 @@ public function setPasswordIncludeUpperCase($password_include_upper_case) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountRoleSettings.php b/src/Model/AccountRoleSettings.php index bef56ef7..4426da8d 100644 --- a/src/Model/AccountRoleSettings.php +++ b/src/Model/AccountRoleSettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountRoleSettings Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountRoleSettings implements ArrayAccess +class AccountRoleSettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountRoleSettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -129,13 +132,111 @@ class AccountRoleSettings implements ArrayAccess 'vaulting_mode_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_account_management' => null, + 'allow_account_management_metadata' => null, + 'allow_api_access' => null, + 'allow_api_access_metadata' => null, + 'allow_api_access_to_account' => null, + 'allow_api_access_to_account_metadata' => null, + 'allow_api_sending_on_behalf_of_others' => null, + 'allow_api_sending_on_behalf_of_others_metadata' => null, + 'allow_api_sequential_signing' => null, + 'allow_api_sequential_signing_metadata' => null, + 'allow_auto_tagging' => null, + 'allow_auto_tagging_metadata' => null, + 'allow_bulk_sending' => null, + 'allow_bulk_sending_metadata' => null, + 'allow_docu_sign_desktop_client' => null, + 'allow_docu_sign_desktop_client_metadata' => null, + 'allowed_address_book_access' => null, + 'allowed_address_book_access_metadata' => null, + 'allowed_clickwraps_access' => null, + 'allowed_clickwraps_access_metadata' => null, + 'allowed_template_access' => null, + 'allowed_template_access_metadata' => null, + 'allowed_to_be_envelope_transfer_recipient' => null, + 'allowed_to_be_envelope_transfer_recipient_metadata' => null, + 'allow_envelope_sending' => null, + 'allow_envelope_sending_metadata' => null, + 'allow_e_seal_recipients' => null, + 'allow_e_seal_recipients_metadata' => null, + 'allow_power_forms_admin_to_access_all_power_form_envelopes' => null, + 'allow_power_forms_admin_to_access_all_power_form_envelopes_metadata' => null, + 'allow_senders_to_set_recipient_email_language' => null, + 'allow_senders_to_set_recipient_email_language_metadata' => null, + 'allow_signer_attachments' => null, + 'allow_signer_attachments_metadata' => null, + 'allow_supplemental_documents' => null, + 'allow_supplemental_documents_metadata' => null, + 'allow_tagging_in_send_and_correct' => null, + 'allow_tagging_in_send_and_correct_metadata' => null, + 'allow_vaulting' => null, + 'allow_vaulting_metadata' => null, + 'allow_wet_signing_override' => null, + 'allow_wet_signing_override_metadata' => null, + 'can_create_workspaces' => null, + 'can_create_workspaces_metadata' => null, + 'disable_document_upload' => null, + 'disable_document_upload_metadata' => null, + 'disable_other_actions' => null, + 'disable_other_actions_metadata' => null, + 'enable_api_request_logging' => null, + 'enable_api_request_logging_metadata' => null, + 'enable_recipient_viewing_notifications' => null, + 'enable_recipient_viewing_notifications_metadata' => null, + 'enable_sequential_signing_interface' => null, + 'enable_sequential_signing_interface_metadata' => null, + 'enable_transaction_point_integration' => null, + 'enable_transaction_point_integration_metadata' => null, + 'power_form_role' => null, + 'power_form_role_metadata' => null, + 'receive_completed_self_signed_documents_as_email_links' => null, + 'receive_completed_self_signed_documents_as_email_links_metadata' => null, + 'signing_ui_version_metadata' => null, + 'supplemental_documents_must_accept' => null, + 'supplemental_documents_must_accept_metadata' => null, + 'supplemental_documents_must_read' => null, + 'supplemental_documents_must_read_metadata' => null, + 'supplemental_documents_must_view' => null, + 'supplemental_documents_must_view_metadata' => null, + 'use_new_docu_sign_experience_interface' => null, + 'use_new_docu_sign_experience_interface_metadata' => null, + 'use_new_sending_interface' => null, + 'use_new_sending_interface_metadata' => null, + 'vaulting_mode' => null, + 'vaulting_mode_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -214,9 +315,9 @@ public static function swaggerTypes() 'vaulting_mode_metadata' => 'vaultingModeMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -295,9 +396,9 @@ public static function swaggerTypes() 'vaulting_mode_metadata' => 'setVaultingModeMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -376,34 +477,63 @@ public static function swaggerTypes() 'vaulting_mode_metadata' => 'getVaultingModeMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -483,30 +613,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allow_account_management + * * @return string */ public function getAllowAccountManagement() @@ -516,7 +648,9 @@ public function getAllowAccountManagement() /** * Sets allow_account_management + * * @param string $allow_account_management + * * @return $this */ public function setAllowAccountManagement($allow_account_management) @@ -528,6 +662,7 @@ public function setAllowAccountManagement($allow_account_management) /** * Gets allow_account_management_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAccountManagementMetadata() @@ -537,7 +672,9 @@ public function getAllowAccountManagementMetadata() /** * Sets allow_account_management_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_account_management_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_account_management_metadata allow_account_management_metadata + * * @return $this */ public function setAllowAccountManagementMetadata($allow_account_management_metadata) @@ -549,6 +686,7 @@ public function setAllowAccountManagementMetadata($allow_account_management_meta /** * Gets allow_api_access + * * @return string */ public function getAllowApiAccess() @@ -558,7 +696,9 @@ public function getAllowApiAccess() /** * Sets allow_api_access + * * @param string $allow_api_access + * * @return $this */ public function setAllowApiAccess($allow_api_access) @@ -570,6 +710,7 @@ public function setAllowApiAccess($allow_api_access) /** * Gets allow_api_access_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowApiAccessMetadata() @@ -579,7 +720,9 @@ public function getAllowApiAccessMetadata() /** * Sets allow_api_access_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_api_access_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_api_access_metadata allow_api_access_metadata + * * @return $this */ public function setAllowApiAccessMetadata($allow_api_access_metadata) @@ -591,6 +734,7 @@ public function setAllowApiAccessMetadata($allow_api_access_metadata) /** * Gets allow_api_access_to_account + * * @return string */ public function getAllowApiAccessToAccount() @@ -600,7 +744,9 @@ public function getAllowApiAccessToAccount() /** * Sets allow_api_access_to_account + * * @param string $allow_api_access_to_account + * * @return $this */ public function setAllowApiAccessToAccount($allow_api_access_to_account) @@ -612,6 +758,7 @@ public function setAllowApiAccessToAccount($allow_api_access_to_account) /** * Gets allow_api_access_to_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowApiAccessToAccountMetadata() @@ -621,7 +768,9 @@ public function getAllowApiAccessToAccountMetadata() /** * Sets allow_api_access_to_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_api_access_to_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_api_access_to_account_metadata allow_api_access_to_account_metadata + * * @return $this */ public function setAllowApiAccessToAccountMetadata($allow_api_access_to_account_metadata) @@ -633,6 +782,7 @@ public function setAllowApiAccessToAccountMetadata($allow_api_access_to_account_ /** * Gets allow_api_sending_on_behalf_of_others + * * @return string */ public function getAllowApiSendingOnBehalfOfOthers() @@ -642,7 +792,9 @@ public function getAllowApiSendingOnBehalfOfOthers() /** * Sets allow_api_sending_on_behalf_of_others + * * @param string $allow_api_sending_on_behalf_of_others + * * @return $this */ public function setAllowApiSendingOnBehalfOfOthers($allow_api_sending_on_behalf_of_others) @@ -654,6 +806,7 @@ public function setAllowApiSendingOnBehalfOfOthers($allow_api_sending_on_behalf_ /** * Gets allow_api_sending_on_behalf_of_others_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowApiSendingOnBehalfOfOthersMetadata() @@ -663,7 +816,9 @@ public function getAllowApiSendingOnBehalfOfOthersMetadata() /** * Sets allow_api_sending_on_behalf_of_others_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_api_sending_on_behalf_of_others_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_api_sending_on_behalf_of_others_metadata allow_api_sending_on_behalf_of_others_metadata + * * @return $this */ public function setAllowApiSendingOnBehalfOfOthersMetadata($allow_api_sending_on_behalf_of_others_metadata) @@ -675,6 +830,7 @@ public function setAllowApiSendingOnBehalfOfOthersMetadata($allow_api_sending_on /** * Gets allow_api_sequential_signing + * * @return string */ public function getAllowApiSequentialSigning() @@ -684,7 +840,9 @@ public function getAllowApiSequentialSigning() /** * Sets allow_api_sequential_signing + * * @param string $allow_api_sequential_signing + * * @return $this */ public function setAllowApiSequentialSigning($allow_api_sequential_signing) @@ -696,6 +854,7 @@ public function setAllowApiSequentialSigning($allow_api_sequential_signing) /** * Gets allow_api_sequential_signing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowApiSequentialSigningMetadata() @@ -705,7 +864,9 @@ public function getAllowApiSequentialSigningMetadata() /** * Sets allow_api_sequential_signing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_api_sequential_signing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_api_sequential_signing_metadata allow_api_sequential_signing_metadata + * * @return $this */ public function setAllowApiSequentialSigningMetadata($allow_api_sequential_signing_metadata) @@ -717,6 +878,7 @@ public function setAllowApiSequentialSigningMetadata($allow_api_sequential_signi /** * Gets allow_auto_tagging + * * @return string */ public function getAllowAutoTagging() @@ -726,7 +888,9 @@ public function getAllowAutoTagging() /** * Sets allow_auto_tagging + * * @param string $allow_auto_tagging + * * @return $this */ public function setAllowAutoTagging($allow_auto_tagging) @@ -738,6 +902,7 @@ public function setAllowAutoTagging($allow_auto_tagging) /** * Gets allow_auto_tagging_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAutoTaggingMetadata() @@ -747,7 +912,9 @@ public function getAllowAutoTaggingMetadata() /** * Sets allow_auto_tagging_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_auto_tagging_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_auto_tagging_metadata allow_auto_tagging_metadata + * * @return $this */ public function setAllowAutoTaggingMetadata($allow_auto_tagging_metadata) @@ -759,6 +926,7 @@ public function setAllowAutoTaggingMetadata($allow_auto_tagging_metadata) /** * Gets allow_bulk_sending + * * @return string */ public function getAllowBulkSending() @@ -768,7 +936,9 @@ public function getAllowBulkSending() /** * Sets allow_bulk_sending + * * @param string $allow_bulk_sending + * * @return $this */ public function setAllowBulkSending($allow_bulk_sending) @@ -780,6 +950,7 @@ public function setAllowBulkSending($allow_bulk_sending) /** * Gets allow_bulk_sending_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowBulkSendingMetadata() @@ -789,7 +960,9 @@ public function getAllowBulkSendingMetadata() /** * Sets allow_bulk_sending_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_bulk_sending_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_bulk_sending_metadata allow_bulk_sending_metadata + * * @return $this */ public function setAllowBulkSendingMetadata($allow_bulk_sending_metadata) @@ -801,6 +974,7 @@ public function setAllowBulkSendingMetadata($allow_bulk_sending_metadata) /** * Gets allow_docu_sign_desktop_client + * * @return string */ public function getAllowDocuSignDesktopClient() @@ -810,7 +984,9 @@ public function getAllowDocuSignDesktopClient() /** * Sets allow_docu_sign_desktop_client + * * @param string $allow_docu_sign_desktop_client + * * @return $this */ public function setAllowDocuSignDesktopClient($allow_docu_sign_desktop_client) @@ -822,6 +998,7 @@ public function setAllowDocuSignDesktopClient($allow_docu_sign_desktop_client) /** * Gets allow_docu_sign_desktop_client_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowDocuSignDesktopClientMetadata() @@ -831,7 +1008,9 @@ public function getAllowDocuSignDesktopClientMetadata() /** * Sets allow_docu_sign_desktop_client_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_docu_sign_desktop_client_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_docu_sign_desktop_client_metadata allow_docu_sign_desktop_client_metadata + * * @return $this */ public function setAllowDocuSignDesktopClientMetadata($allow_docu_sign_desktop_client_metadata) @@ -843,6 +1022,7 @@ public function setAllowDocuSignDesktopClientMetadata($allow_docu_sign_desktop_c /** * Gets allowed_address_book_access + * * @return string */ public function getAllowedAddressBookAccess() @@ -852,7 +1032,9 @@ public function getAllowedAddressBookAccess() /** * Sets allowed_address_book_access + * * @param string $allowed_address_book_access + * * @return $this */ public function setAllowedAddressBookAccess($allowed_address_book_access) @@ -864,6 +1046,7 @@ public function setAllowedAddressBookAccess($allowed_address_book_access) /** * Gets allowed_address_book_access_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowedAddressBookAccessMetadata() @@ -873,7 +1056,9 @@ public function getAllowedAddressBookAccessMetadata() /** * Sets allowed_address_book_access_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allowed_address_book_access_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allowed_address_book_access_metadata allowed_address_book_access_metadata + * * @return $this */ public function setAllowedAddressBookAccessMetadata($allowed_address_book_access_metadata) @@ -885,6 +1070,7 @@ public function setAllowedAddressBookAccessMetadata($allowed_address_book_access /** * Gets allowed_clickwraps_access + * * @return string */ public function getAllowedClickwrapsAccess() @@ -894,7 +1080,9 @@ public function getAllowedClickwrapsAccess() /** * Sets allowed_clickwraps_access + * * @param string $allowed_clickwraps_access + * * @return $this */ public function setAllowedClickwrapsAccess($allowed_clickwraps_access) @@ -906,6 +1094,7 @@ public function setAllowedClickwrapsAccess($allowed_clickwraps_access) /** * Gets allowed_clickwraps_access_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowedClickwrapsAccessMetadata() @@ -915,7 +1104,9 @@ public function getAllowedClickwrapsAccessMetadata() /** * Sets allowed_clickwraps_access_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allowed_clickwraps_access_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allowed_clickwraps_access_metadata allowed_clickwraps_access_metadata + * * @return $this */ public function setAllowedClickwrapsAccessMetadata($allowed_clickwraps_access_metadata) @@ -927,6 +1118,7 @@ public function setAllowedClickwrapsAccessMetadata($allowed_clickwraps_access_me /** * Gets allowed_template_access + * * @return string */ public function getAllowedTemplateAccess() @@ -936,7 +1128,9 @@ public function getAllowedTemplateAccess() /** * Sets allowed_template_access + * * @param string $allowed_template_access + * * @return $this */ public function setAllowedTemplateAccess($allowed_template_access) @@ -948,6 +1142,7 @@ public function setAllowedTemplateAccess($allowed_template_access) /** * Gets allowed_template_access_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowedTemplateAccessMetadata() @@ -957,7 +1152,9 @@ public function getAllowedTemplateAccessMetadata() /** * Sets allowed_template_access_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allowed_template_access_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allowed_template_access_metadata allowed_template_access_metadata + * * @return $this */ public function setAllowedTemplateAccessMetadata($allowed_template_access_metadata) @@ -969,6 +1166,7 @@ public function setAllowedTemplateAccessMetadata($allowed_template_access_metada /** * Gets allowed_to_be_envelope_transfer_recipient + * * @return string */ public function getAllowedToBeEnvelopeTransferRecipient() @@ -978,7 +1176,9 @@ public function getAllowedToBeEnvelopeTransferRecipient() /** * Sets allowed_to_be_envelope_transfer_recipient + * * @param string $allowed_to_be_envelope_transfer_recipient + * * @return $this */ public function setAllowedToBeEnvelopeTransferRecipient($allowed_to_be_envelope_transfer_recipient) @@ -990,6 +1190,7 @@ public function setAllowedToBeEnvelopeTransferRecipient($allowed_to_be_envelope_ /** * Gets allowed_to_be_envelope_transfer_recipient_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowedToBeEnvelopeTransferRecipientMetadata() @@ -999,7 +1200,9 @@ public function getAllowedToBeEnvelopeTransferRecipientMetadata() /** * Sets allowed_to_be_envelope_transfer_recipient_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allowed_to_be_envelope_transfer_recipient_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allowed_to_be_envelope_transfer_recipient_metadata allowed_to_be_envelope_transfer_recipient_metadata + * * @return $this */ public function setAllowedToBeEnvelopeTransferRecipientMetadata($allowed_to_be_envelope_transfer_recipient_metadata) @@ -1011,6 +1214,7 @@ public function setAllowedToBeEnvelopeTransferRecipientMetadata($allowed_to_be_e /** * Gets allow_envelope_sending + * * @return string */ public function getAllowEnvelopeSending() @@ -1020,7 +1224,9 @@ public function getAllowEnvelopeSending() /** * Sets allow_envelope_sending + * * @param string $allow_envelope_sending + * * @return $this */ public function setAllowEnvelopeSending($allow_envelope_sending) @@ -1032,6 +1238,7 @@ public function setAllowEnvelopeSending($allow_envelope_sending) /** * Gets allow_envelope_sending_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEnvelopeSendingMetadata() @@ -1041,7 +1248,9 @@ public function getAllowEnvelopeSendingMetadata() /** * Sets allow_envelope_sending_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_sending_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_sending_metadata allow_envelope_sending_metadata + * * @return $this */ public function setAllowEnvelopeSendingMetadata($allow_envelope_sending_metadata) @@ -1053,6 +1262,7 @@ public function setAllowEnvelopeSendingMetadata($allow_envelope_sending_metadata /** * Gets allow_e_seal_recipients + * * @return string */ public function getAllowESealRecipients() @@ -1062,7 +1272,9 @@ public function getAllowESealRecipients() /** * Sets allow_e_seal_recipients + * * @param string $allow_e_seal_recipients + * * @return $this */ public function setAllowESealRecipients($allow_e_seal_recipients) @@ -1074,6 +1286,7 @@ public function setAllowESealRecipients($allow_e_seal_recipients) /** * Gets allow_e_seal_recipients_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowESealRecipientsMetadata() @@ -1083,7 +1296,9 @@ public function getAllowESealRecipientsMetadata() /** * Sets allow_e_seal_recipients_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_e_seal_recipients_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_e_seal_recipients_metadata allow_e_seal_recipients_metadata + * * @return $this */ public function setAllowESealRecipientsMetadata($allow_e_seal_recipients_metadata) @@ -1095,6 +1310,7 @@ public function setAllowESealRecipientsMetadata($allow_e_seal_recipients_metadat /** * Gets allow_power_forms_admin_to_access_all_power_form_envelopes + * * @return string */ public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelopes() @@ -1104,7 +1320,9 @@ public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelopes() /** * 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) @@ -1116,6 +1334,7 @@ public function setAllowPowerFormsAdminToAccessAllPowerFormEnvelopes($allow_powe /** * Gets allow_power_forms_admin_to_access_all_power_form_envelopes_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata() @@ -1125,7 +1344,9 @@ public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata() /** * 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 + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_power_forms_admin_to_access_all_power_form_envelopes_metadata 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) @@ -1137,6 +1358,7 @@ public function setAllowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata($al /** * Gets allow_senders_to_set_recipient_email_language + * * @return string */ public function getAllowSendersToSetRecipientEmailLanguage() @@ -1146,7 +1368,9 @@ public function getAllowSendersToSetRecipientEmailLanguage() /** * Sets allow_senders_to_set_recipient_email_language + * * @param string $allow_senders_to_set_recipient_email_language + * * @return $this */ public function setAllowSendersToSetRecipientEmailLanguage($allow_senders_to_set_recipient_email_language) @@ -1158,6 +1382,7 @@ public function setAllowSendersToSetRecipientEmailLanguage($allow_senders_to_set /** * Gets allow_senders_to_set_recipient_email_language_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSendersToSetRecipientEmailLanguageMetadata() @@ -1167,7 +1392,9 @@ public function getAllowSendersToSetRecipientEmailLanguageMetadata() /** * Sets allow_senders_to_set_recipient_email_language_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_senders_to_set_recipient_email_language_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_senders_to_set_recipient_email_language_metadata allow_senders_to_set_recipient_email_language_metadata + * * @return $this */ public function setAllowSendersToSetRecipientEmailLanguageMetadata($allow_senders_to_set_recipient_email_language_metadata) @@ -1179,6 +1406,7 @@ public function setAllowSendersToSetRecipientEmailLanguageMetadata($allow_sender /** * Gets allow_signer_attachments + * * @return string */ public function getAllowSignerAttachments() @@ -1188,7 +1416,9 @@ public function getAllowSignerAttachments() /** * Sets allow_signer_attachments + * * @param string $allow_signer_attachments + * * @return $this */ public function setAllowSignerAttachments($allow_signer_attachments) @@ -1200,6 +1430,7 @@ public function setAllowSignerAttachments($allow_signer_attachments) /** * Gets allow_signer_attachments_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSignerAttachmentsMetadata() @@ -1209,7 +1440,9 @@ public function getAllowSignerAttachmentsMetadata() /** * Sets allow_signer_attachments_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signer_attachments_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signer_attachments_metadata allow_signer_attachments_metadata + * * @return $this */ public function setAllowSignerAttachmentsMetadata($allow_signer_attachments_metadata) @@ -1221,6 +1454,7 @@ public function setAllowSignerAttachmentsMetadata($allow_signer_attachments_meta /** * Gets allow_supplemental_documents + * * @return string */ public function getAllowSupplementalDocuments() @@ -1230,7 +1464,9 @@ public function getAllowSupplementalDocuments() /** * Sets allow_supplemental_documents + * * @param string $allow_supplemental_documents + * * @return $this */ public function setAllowSupplementalDocuments($allow_supplemental_documents) @@ -1242,6 +1478,7 @@ public function setAllowSupplementalDocuments($allow_supplemental_documents) /** * Gets allow_supplemental_documents_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSupplementalDocumentsMetadata() @@ -1251,7 +1488,9 @@ public function getAllowSupplementalDocumentsMetadata() /** * Sets allow_supplemental_documents_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_supplemental_documents_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_supplemental_documents_metadata allow_supplemental_documents_metadata + * * @return $this */ public function setAllowSupplementalDocumentsMetadata($allow_supplemental_documents_metadata) @@ -1263,6 +1502,7 @@ public function setAllowSupplementalDocumentsMetadata($allow_supplemental_docume /** * Gets allow_tagging_in_send_and_correct + * * @return string */ public function getAllowTaggingInSendAndCorrect() @@ -1272,7 +1512,9 @@ public function getAllowTaggingInSendAndCorrect() /** * Sets allow_tagging_in_send_and_correct + * * @param string $allow_tagging_in_send_and_correct + * * @return $this */ public function setAllowTaggingInSendAndCorrect($allow_tagging_in_send_and_correct) @@ -1284,6 +1526,7 @@ public function setAllowTaggingInSendAndCorrect($allow_tagging_in_send_and_corre /** * Gets allow_tagging_in_send_and_correct_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowTaggingInSendAndCorrectMetadata() @@ -1293,7 +1536,9 @@ public function getAllowTaggingInSendAndCorrectMetadata() /** * Sets allow_tagging_in_send_and_correct_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_tagging_in_send_and_correct_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_tagging_in_send_and_correct_metadata allow_tagging_in_send_and_correct_metadata + * * @return $this */ public function setAllowTaggingInSendAndCorrectMetadata($allow_tagging_in_send_and_correct_metadata) @@ -1305,6 +1550,7 @@ public function setAllowTaggingInSendAndCorrectMetadata($allow_tagging_in_send_a /** * Gets allow_vaulting + * * @return string */ public function getAllowVaulting() @@ -1314,7 +1560,9 @@ public function getAllowVaulting() /** * Sets allow_vaulting + * * @param string $allow_vaulting + * * @return $this */ public function setAllowVaulting($allow_vaulting) @@ -1326,6 +1574,7 @@ public function setAllowVaulting($allow_vaulting) /** * Gets allow_vaulting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowVaultingMetadata() @@ -1335,7 +1584,9 @@ public function getAllowVaultingMetadata() /** * Sets allow_vaulting_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_vaulting_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_vaulting_metadata allow_vaulting_metadata + * * @return $this */ public function setAllowVaultingMetadata($allow_vaulting_metadata) @@ -1347,6 +1598,7 @@ public function setAllowVaultingMetadata($allow_vaulting_metadata) /** * Gets allow_wet_signing_override + * * @return string */ public function getAllowWetSigningOverride() @@ -1356,7 +1608,9 @@ public function getAllowWetSigningOverride() /** * Sets allow_wet_signing_override + * * @param string $allow_wet_signing_override + * * @return $this */ public function setAllowWetSigningOverride($allow_wet_signing_override) @@ -1368,6 +1622,7 @@ public function setAllowWetSigningOverride($allow_wet_signing_override) /** * Gets allow_wet_signing_override_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowWetSigningOverrideMetadata() @@ -1377,7 +1632,9 @@ public function getAllowWetSigningOverrideMetadata() /** * Sets allow_wet_signing_override_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_wet_signing_override_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_wet_signing_override_metadata allow_wet_signing_override_metadata + * * @return $this */ public function setAllowWetSigningOverrideMetadata($allow_wet_signing_override_metadata) @@ -1389,6 +1646,7 @@ public function setAllowWetSigningOverrideMetadata($allow_wet_signing_override_m /** * Gets can_create_workspaces + * * @return string */ public function getCanCreateWorkspaces() @@ -1398,7 +1656,9 @@ public function getCanCreateWorkspaces() /** * Sets can_create_workspaces + * * @param string $can_create_workspaces + * * @return $this */ public function setCanCreateWorkspaces($can_create_workspaces) @@ -1410,6 +1670,7 @@ public function setCanCreateWorkspaces($can_create_workspaces) /** * Gets can_create_workspaces_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanCreateWorkspacesMetadata() @@ -1419,7 +1680,9 @@ public function getCanCreateWorkspacesMetadata() /** * Sets can_create_workspaces_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_create_workspaces_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_create_workspaces_metadata can_create_workspaces_metadata + * * @return $this */ public function setCanCreateWorkspacesMetadata($can_create_workspaces_metadata) @@ -1431,6 +1694,7 @@ public function setCanCreateWorkspacesMetadata($can_create_workspaces_metadata) /** * Gets disable_document_upload + * * @return string */ public function getDisableDocumentUpload() @@ -1440,7 +1704,9 @@ public function getDisableDocumentUpload() /** * Sets disable_document_upload + * * @param string $disable_document_upload + * * @return $this */ public function setDisableDocumentUpload($disable_document_upload) @@ -1452,6 +1718,7 @@ public function setDisableDocumentUpload($disable_document_upload) /** * Gets disable_document_upload_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableDocumentUploadMetadata() @@ -1461,7 +1728,9 @@ public function getDisableDocumentUploadMetadata() /** * Sets disable_document_upload_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_document_upload_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_document_upload_metadata disable_document_upload_metadata + * * @return $this */ public function setDisableDocumentUploadMetadata($disable_document_upload_metadata) @@ -1473,6 +1742,7 @@ public function setDisableDocumentUploadMetadata($disable_document_upload_metada /** * Gets disable_other_actions + * * @return string */ public function getDisableOtherActions() @@ -1482,7 +1752,9 @@ public function getDisableOtherActions() /** * Sets disable_other_actions + * * @param string $disable_other_actions + * * @return $this */ public function setDisableOtherActions($disable_other_actions) @@ -1494,6 +1766,7 @@ public function setDisableOtherActions($disable_other_actions) /** * Gets disable_other_actions_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableOtherActionsMetadata() @@ -1503,7 +1776,9 @@ public function getDisableOtherActionsMetadata() /** * Sets disable_other_actions_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_other_actions_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_other_actions_metadata disable_other_actions_metadata + * * @return $this */ public function setDisableOtherActionsMetadata($disable_other_actions_metadata) @@ -1515,6 +1790,7 @@ public function setDisableOtherActionsMetadata($disable_other_actions_metadata) /** * Gets enable_api_request_logging + * * @return string */ public function getEnableApiRequestLogging() @@ -1524,7 +1800,9 @@ public function getEnableApiRequestLogging() /** * Sets enable_api_request_logging + * * @param string $enable_api_request_logging + * * @return $this */ public function setEnableApiRequestLogging($enable_api_request_logging) @@ -1536,6 +1814,7 @@ public function setEnableApiRequestLogging($enable_api_request_logging) /** * Gets enable_api_request_logging_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableApiRequestLoggingMetadata() @@ -1545,7 +1824,9 @@ public function getEnableApiRequestLoggingMetadata() /** * Sets enable_api_request_logging_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_api_request_logging_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_api_request_logging_metadata enable_api_request_logging_metadata + * * @return $this */ public function setEnableApiRequestLoggingMetadata($enable_api_request_logging_metadata) @@ -1557,6 +1838,7 @@ public function setEnableApiRequestLoggingMetadata($enable_api_request_logging_m /** * Gets enable_recipient_viewing_notifications + * * @return string */ public function getEnableRecipientViewingNotifications() @@ -1566,7 +1848,9 @@ public function getEnableRecipientViewingNotifications() /** * Sets enable_recipient_viewing_notifications + * * @param string $enable_recipient_viewing_notifications + * * @return $this */ public function setEnableRecipientViewingNotifications($enable_recipient_viewing_notifications) @@ -1578,6 +1862,7 @@ public function setEnableRecipientViewingNotifications($enable_recipient_viewing /** * Gets enable_recipient_viewing_notifications_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableRecipientViewingNotificationsMetadata() @@ -1587,7 +1872,9 @@ public function getEnableRecipientViewingNotificationsMetadata() /** * Sets enable_recipient_viewing_notifications_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_recipient_viewing_notifications_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_recipient_viewing_notifications_metadata enable_recipient_viewing_notifications_metadata + * * @return $this */ public function setEnableRecipientViewingNotificationsMetadata($enable_recipient_viewing_notifications_metadata) @@ -1599,6 +1886,7 @@ public function setEnableRecipientViewingNotificationsMetadata($enable_recipient /** * Gets enable_sequential_signing_interface + * * @return string */ public function getEnableSequentialSigningInterface() @@ -1608,7 +1896,9 @@ public function getEnableSequentialSigningInterface() /** * Sets enable_sequential_signing_interface + * * @param string $enable_sequential_signing_interface + * * @return $this */ public function setEnableSequentialSigningInterface($enable_sequential_signing_interface) @@ -1620,6 +1910,7 @@ public function setEnableSequentialSigningInterface($enable_sequential_signing_i /** * Gets enable_sequential_signing_interface_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSequentialSigningInterfaceMetadata() @@ -1629,7 +1920,9 @@ public function getEnableSequentialSigningInterfaceMetadata() /** * Sets enable_sequential_signing_interface_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_interface_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_interface_metadata enable_sequential_signing_interface_metadata + * * @return $this */ public function setEnableSequentialSigningInterfaceMetadata($enable_sequential_signing_interface_metadata) @@ -1641,6 +1934,7 @@ public function setEnableSequentialSigningInterfaceMetadata($enable_sequential_s /** * Gets enable_transaction_point_integration + * * @return string */ public function getEnableTransactionPointIntegration() @@ -1650,7 +1944,9 @@ public function getEnableTransactionPointIntegration() /** * Sets enable_transaction_point_integration + * * @param string $enable_transaction_point_integration + * * @return $this */ public function setEnableTransactionPointIntegration($enable_transaction_point_integration) @@ -1662,6 +1958,7 @@ public function setEnableTransactionPointIntegration($enable_transaction_point_i /** * Gets enable_transaction_point_integration_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableTransactionPointIntegrationMetadata() @@ -1671,7 +1968,9 @@ public function getEnableTransactionPointIntegrationMetadata() /** * Sets enable_transaction_point_integration_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_transaction_point_integration_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_transaction_point_integration_metadata enable_transaction_point_integration_metadata + * * @return $this */ public function setEnableTransactionPointIntegrationMetadata($enable_transaction_point_integration_metadata) @@ -1683,6 +1982,7 @@ public function setEnableTransactionPointIntegrationMetadata($enable_transaction /** * Gets power_form_role + * * @return string */ public function getPowerFormRole() @@ -1692,7 +1992,9 @@ public function getPowerFormRole() /** * Sets power_form_role + * * @param string $power_form_role + * * @return $this */ public function setPowerFormRole($power_form_role) @@ -1704,6 +2006,7 @@ public function setPowerFormRole($power_form_role) /** * Gets power_form_role_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getPowerFormRoleMetadata() @@ -1713,7 +2016,9 @@ public function getPowerFormRoleMetadata() /** * Sets power_form_role_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $power_form_role_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $power_form_role_metadata power_form_role_metadata + * * @return $this */ public function setPowerFormRoleMetadata($power_form_role_metadata) @@ -1725,6 +2030,7 @@ public function setPowerFormRoleMetadata($power_form_role_metadata) /** * Gets receive_completed_self_signed_documents_as_email_links + * * @return string */ public function getReceiveCompletedSelfSignedDocumentsAsEmailLinks() @@ -1734,7 +2040,9 @@ public function getReceiveCompletedSelfSignedDocumentsAsEmailLinks() /** * Sets receive_completed_self_signed_documents_as_email_links + * * @param string $receive_completed_self_signed_documents_as_email_links + * * @return $this */ public function setReceiveCompletedSelfSignedDocumentsAsEmailLinks($receive_completed_self_signed_documents_as_email_links) @@ -1746,6 +2054,7 @@ public function setReceiveCompletedSelfSignedDocumentsAsEmailLinks($receive_comp /** * Gets receive_completed_self_signed_documents_as_email_links_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getReceiveCompletedSelfSignedDocumentsAsEmailLinksMetadata() @@ -1755,7 +2064,9 @@ public function getReceiveCompletedSelfSignedDocumentsAsEmailLinksMetadata() /** * Sets receive_completed_self_signed_documents_as_email_links_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $receive_completed_self_signed_documents_as_email_links_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $receive_completed_self_signed_documents_as_email_links_metadata receive_completed_self_signed_documents_as_email_links_metadata + * * @return $this */ public function setReceiveCompletedSelfSignedDocumentsAsEmailLinksMetadata($receive_completed_self_signed_documents_as_email_links_metadata) @@ -1767,6 +2078,7 @@ public function setReceiveCompletedSelfSignedDocumentsAsEmailLinksMetadata($rece /** * Gets signing_ui_version_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSigningUiVersionMetadata() @@ -1776,7 +2088,9 @@ public function getSigningUiVersionMetadata() /** * Sets signing_ui_version_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signing_ui_version_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signing_ui_version_metadata signing_ui_version_metadata + * * @return $this */ public function setSigningUiVersionMetadata($signing_ui_version_metadata) @@ -1788,6 +2102,7 @@ public function setSigningUiVersionMetadata($signing_ui_version_metadata) /** * Gets supplemental_documents_must_accept + * * @return string */ public function getSupplementalDocumentsMustAccept() @@ -1797,7 +2112,9 @@ public function getSupplementalDocumentsMustAccept() /** * Sets supplemental_documents_must_accept + * * @param string $supplemental_documents_must_accept + * * @return $this */ public function setSupplementalDocumentsMustAccept($supplemental_documents_must_accept) @@ -1809,6 +2126,7 @@ public function setSupplementalDocumentsMustAccept($supplemental_documents_must_ /** * Gets supplemental_documents_must_accept_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustAcceptMetadata() @@ -1818,7 +2136,9 @@ public function getSupplementalDocumentsMustAcceptMetadata() /** * Sets supplemental_documents_must_accept_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_accept_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_accept_metadata supplemental_documents_must_accept_metadata + * * @return $this */ public function setSupplementalDocumentsMustAcceptMetadata($supplemental_documents_must_accept_metadata) @@ -1830,6 +2150,7 @@ public function setSupplementalDocumentsMustAcceptMetadata($supplemental_documen /** * Gets supplemental_documents_must_read + * * @return string */ public function getSupplementalDocumentsMustRead() @@ -1839,7 +2160,9 @@ public function getSupplementalDocumentsMustRead() /** * Sets supplemental_documents_must_read + * * @param string $supplemental_documents_must_read + * * @return $this */ public function setSupplementalDocumentsMustRead($supplemental_documents_must_read) @@ -1851,6 +2174,7 @@ public function setSupplementalDocumentsMustRead($supplemental_documents_must_re /** * Gets supplemental_documents_must_read_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustReadMetadata() @@ -1860,7 +2184,9 @@ public function getSupplementalDocumentsMustReadMetadata() /** * Sets supplemental_documents_must_read_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_read_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_read_metadata supplemental_documents_must_read_metadata + * * @return $this */ public function setSupplementalDocumentsMustReadMetadata($supplemental_documents_must_read_metadata) @@ -1872,6 +2198,7 @@ public function setSupplementalDocumentsMustReadMetadata($supplemental_documents /** * Gets supplemental_documents_must_view + * * @return string */ public function getSupplementalDocumentsMustView() @@ -1881,7 +2208,9 @@ public function getSupplementalDocumentsMustView() /** * Sets supplemental_documents_must_view + * * @param string $supplemental_documents_must_view + * * @return $this */ public function setSupplementalDocumentsMustView($supplemental_documents_must_view) @@ -1893,6 +2222,7 @@ public function setSupplementalDocumentsMustView($supplemental_documents_must_vi /** * Gets supplemental_documents_must_view_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustViewMetadata() @@ -1902,7 +2232,9 @@ public function getSupplementalDocumentsMustViewMetadata() /** * Sets supplemental_documents_must_view_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_view_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_view_metadata supplemental_documents_must_view_metadata + * * @return $this */ public function setSupplementalDocumentsMustViewMetadata($supplemental_documents_must_view_metadata) @@ -1914,6 +2246,7 @@ public function setSupplementalDocumentsMustViewMetadata($supplemental_documents /** * Gets use_new_docu_sign_experience_interface + * * @return string */ public function getUseNewDocuSignExperienceInterface() @@ -1923,7 +2256,9 @@ public function getUseNewDocuSignExperienceInterface() /** * Sets use_new_docu_sign_experience_interface + * * @param string $use_new_docu_sign_experience_interface + * * @return $this */ public function setUseNewDocuSignExperienceInterface($use_new_docu_sign_experience_interface) @@ -1935,6 +2270,7 @@ public function setUseNewDocuSignExperienceInterface($use_new_docu_sign_experien /** * Gets use_new_docu_sign_experience_interface_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseNewDocuSignExperienceInterfaceMetadata() @@ -1944,7 +2280,9 @@ public function getUseNewDocuSignExperienceInterfaceMetadata() /** * Sets use_new_docu_sign_experience_interface_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_new_docu_sign_experience_interface_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_new_docu_sign_experience_interface_metadata use_new_docu_sign_experience_interface_metadata + * * @return $this */ public function setUseNewDocuSignExperienceInterfaceMetadata($use_new_docu_sign_experience_interface_metadata) @@ -1956,6 +2294,7 @@ public function setUseNewDocuSignExperienceInterfaceMetadata($use_new_docu_sign_ /** * Gets use_new_sending_interface + * * @return string */ public function getUseNewSendingInterface() @@ -1965,7 +2304,9 @@ public function getUseNewSendingInterface() /** * Sets use_new_sending_interface + * * @param string $use_new_sending_interface + * * @return $this */ public function setUseNewSendingInterface($use_new_sending_interface) @@ -1977,6 +2318,7 @@ public function setUseNewSendingInterface($use_new_sending_interface) /** * Gets use_new_sending_interface_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseNewSendingInterfaceMetadata() @@ -1986,7 +2328,9 @@ public function getUseNewSendingInterfaceMetadata() /** * Sets use_new_sending_interface_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_new_sending_interface_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_new_sending_interface_metadata use_new_sending_interface_metadata + * * @return $this */ public function setUseNewSendingInterfaceMetadata($use_new_sending_interface_metadata) @@ -1998,6 +2342,7 @@ public function setUseNewSendingInterfaceMetadata($use_new_sending_interface_met /** * Gets vaulting_mode + * * @return string */ public function getVaultingMode() @@ -2007,7 +2352,9 @@ public function getVaultingMode() /** * Sets vaulting_mode + * * @param string $vaulting_mode + * * @return $this */ public function setVaultingMode($vaulting_mode) @@ -2019,6 +2366,7 @@ public function setVaultingMode($vaulting_mode) /** * Gets vaulting_mode_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getVaultingModeMetadata() @@ -2028,7 +2376,9 @@ public function getVaultingModeMetadata() /** * Sets vaulting_mode_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $vaulting_mode_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $vaulting_mode_metadata vaulting_mode_metadata + * * @return $this */ public function setVaultingModeMetadata($vaulting_mode_metadata) @@ -2039,7 +2389,9 @@ public function setVaultingModeMetadata($vaulting_mode_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2049,7 +2401,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2059,8 +2413,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2074,7 +2430,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2084,16 +2442,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountSeals.php b/src/Model/AccountSeals.php index 91ddd3be..34833330 100644 --- a/src/Model/AccountSeals.php +++ b/src/Model/AccountSeals.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountSeals Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountSeals implements ArrayAccess +class AccountSeals implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountSeals'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'seals' => '\DocuSign\eSign\Model\SealIdentifier[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'seals' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ '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' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets seals + * * @return \DocuSign\eSign\Model\SealIdentifier[] */ public function getSeals() @@ -156,7 +216,9 @@ public function getSeals() /** * Sets seals + * * @param \DocuSign\eSign\Model\SealIdentifier[] $seals + * * @return $this */ public function setSeals($seals) @@ -167,7 +229,9 @@ public function setSeals($seals) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountSettingsInformation.php b/src/Model/AccountSettingsInformation.php index b15d09e2..99b80fa6 100644 --- a/src/Model/AccountSettingsInformation.php +++ b/src/Model/AccountSettingsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountSettingsInformation Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountSettingsInformation implements ArrayAccess +class AccountSettingsInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountSettingsInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -571,13 +574,552 @@ class AccountSettingsInformation implements ArrayAccess 'wurfl_min_allowable_screen_size_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code_format' => null, + 'account_date_time_format' => null, + 'account_date_time_format_metadata' => null, + 'account_name' => null, + 'account_name_metadata' => null, + 'account_notification' => null, + 'account_ui_settings' => null, + 'adopt_sig_config' => null, + 'adopt_sig_config_metadata' => null, + 'advanced_correct' => null, + 'advanced_correct_metadata' => null, + 'allow_access_code_format' => null, + 'allow_access_code_format_metadata' => null, + 'allow_account_management_granular' => null, + 'allow_account_management_granular_metadata' => null, + 'allow_account_member_name_change' => null, + 'allow_account_member_name_change_metadata' => null, + 'allow_advanced_recipient_routing_conditional' => null, + 'allow_advanced_recipient_routing_conditional_metadata' => null, + 'allow_agent_name_email_edit' => null, + 'allow_agent_name_email_edit_metadata' => null, + 'allow_agreement_actions' => null, + 'allow_agreement_actions_metadata' => null, + 'allow_auto_nav_settings' => null, + 'allow_auto_nav_settings_metadata' => null, + 'allow_auto_tagging' => null, + 'allow_auto_tagging_metadata' => null, + 'allow_bulk_send' => null, + 'allow_bulk_send_metadata' => null, + 'allow_cd_withdraw' => null, + 'allow_cd_withdraw_metadata' => null, + 'allow_connect_http_listener_configs' => null, + 'allow_connect_send_finish_later' => null, + 'allow_connect_send_finish_later_metadata' => null, + 'allow_consumer_disclosure_override' => null, + 'allow_consumer_disclosure_override_metadata' => null, + 'allow_data_download' => null, + 'allow_data_download_metadata' => null, + 'allow_document_disclosures' => null, + 'allow_document_disclosures_metadata' => null, + 'allow_documents_on_signed_envelopes' => null, + 'allow_documents_on_signed_envelopes_metadata' => null, + 'allow_document_visibility' => null, + 'allow_document_visibility_metadata' => null, + 'allow_e_hanko_stamps' => null, + 'allow_e_hanko_stamps_metadata' => null, + 'allow_e_note_e_original' => null, + 'allow_e_note_e_original_metadata' => null, + 'allow_envelope_correct' => null, + 'allow_envelope_correct_metadata' => null, + 'allow_envelope_custody_transfer' => null, + 'allow_envelope_custody_transfer_metadata' => null, + 'allow_envelope_custom_fields' => null, + 'allow_envelope_custom_fields_metadata' => null, + 'allow_envelope_publish_reporting' => null, + 'allow_envelope_publish_reporting_metadata' => null, + 'allow_envelope_reporting' => null, + 'allow_envelope_reporting_metadata' => null, + 'allow_expression' => null, + 'allow_expression_metadata' => null, + 'allow_express_signer_certificate' => null, + 'allow_express_signer_certificate_metadata' => null, + 'allow_extended_sending_resource_file' => null, + 'allow_extended_sending_resource_file_metadata' => null, + 'allow_external_signature_pad' => null, + 'allow_external_signature_pad_metadata' => null, + 'allow_idv_level1' => null, + 'allow_idv_level1_metadata' => null, + 'allow_idv_platform' => null, + 'allow_idv_platform_metadata' => null, + 'allow_in_person' => null, + 'allow_in_person_metadata' => null, + 'allow_managed_stamps' => null, + 'allow_managed_stamps_metadata' => null, + 'allow_markup' => null, + 'allow_markup_metadata' => null, + 'allow_member_time_zone' => null, + 'allow_member_time_zone_metadata' => null, + 'allow_merge_fields' => null, + 'allow_merge_fields_metadata' => null, + 'allow_multiple_brand_profiles' => null, + 'allow_multiple_brand_profiles_metadata' => null, + 'allow_multiple_signer_attachments' => null, + 'allow_multiple_signer_attachments_metadata' => null, + 'allow_non_us_phone_auth' => null, + 'allow_non_us_phone_auth_metadata' => null, + 'allow_ocr_of_envelope_documents' => null, + 'allow_ocr_of_envelope_documents_metadata' => null, + 'allow_offline_signing' => null, + 'allow_offline_signing_metadata' => null, + 'allow_open_trust_signer_certificate' => null, + 'allow_open_trust_signer_certificate_metadata' => null, + 'allow_organizations' => null, + 'allow_organizations_metadata' => null, + 'allow_payment_processing' => null, + 'allow_payment_processing_metadata' => null, + 'allow_personal_signer_certificate' => null, + 'allow_personal_signer_certificate_metadata' => null, + 'allow_phone_authentication' => null, + 'allow_phone_authentication_metadata' => null, + 'allow_phone_auth_override' => null, + 'allow_phone_auth_override_metadata' => null, + 'allow_private_signing_groups' => null, + 'allow_private_signing_groups_metadata' => null, + 'allow_reminders' => null, + 'allow_reminders_metadata' => null, + 'allow_resource_file_branding' => null, + 'allow_resource_file_branding_metadata' => null, + 'allow_safe_bio_pharma_signer_certificate' => null, + 'allow_safe_bio_pharma_signer_certificate_metadata' => null, + 'allow_security_appliance' => null, + 'allow_security_appliance_metadata' => null, + 'allow_send_to_certified_delivery' => null, + 'allow_send_to_certified_delivery_metadata' => null, + 'allow_send_to_intermediary' => null, + 'allow_send_to_intermediary_metadata' => null, + 'allow_server_templates' => null, + 'allow_server_templates_metadata' => null, + 'allow_set_embedded_recipient_start_url' => null, + 'allow_set_embedded_recipient_start_url_metadata' => null, + 'allow_shared_tabs' => null, + 'allow_shared_tabs_metadata' => null, + 'allow_signature_stamps' => null, + 'allow_signature_stamps_metadata' => null, + 'allow_sign_document_from_home_page' => null, + 'allow_sign_document_from_home_page_metadata' => null, + 'allow_signer_reassign' => null, + 'allow_signer_reassign_metadata' => null, + 'allow_signer_reassign_override' => null, + 'allow_signer_reassign_override_metadata' => null, + 'allow_signing_extensions' => null, + 'allow_signing_extensions_metadata' => null, + 'allow_signing_groups' => null, + 'allow_signing_groups_metadata' => null, + 'allow_signing_radio_deselect' => null, + 'allow_signing_radio_deselect_metadata' => null, + 'allow_sign_now' => null, + 'allow_sign_now_metadata' => null, + 'allow_sms_delivery' => null, + 'allow_sms_delivery_metadata' => null, + 'allow_social_id_login' => null, + 'allow_social_id_login_metadata' => null, + 'allow_supplemental_documents' => null, + 'allow_supplemental_documents_metadata' => null, + 'allow_users_to_access_directory' => null, + 'allow_users_to_access_directory_metadata' => null, + 'allow_value_insights' => null, + 'allow_value_insights_metadata' => null, + 'anchor_population_scope' => null, + 'anchor_population_scope_metadata' => null, + 'anchor_tag_versioned_placement_enabled' => null, + 'anchor_tag_versioned_placement_metadata_enabled' => null, + 'attach_completed_envelope' => null, + 'attach_completed_envelope_metadata' => null, + 'authentication_check' => null, + 'authentication_check_metadata' => null, + 'auto_nav_rule' => null, + 'auto_nav_rule_metadata' => null, + 'auto_provision_signer_account' => null, + 'auto_provision_signer_account_metadata' => null, + 'bcc_email_archive' => null, + 'bcc_email_archive_metadata' => null, + 'beta_switch_configuration' => null, + 'beta_switch_configuration_metadata' => null, + 'billing_address' => null, + 'billing_address_metadata' => null, + 'bulk_send' => null, + 'bulk_send_max_copies_in_batch' => null, + 'bulk_send_max_unprocessed_envelopes_count' => null, + 'bulk_send_metadata' => null, + 'can_self_brand_send' => null, + 'can_self_brand_send_metadata' => null, + 'can_self_brand_sign' => null, + 'can_self_brand_sign_metadata' => null, + 'can_use_salesforce_o_auth' => null, + 'can_use_salesforce_o_auth_metadata' => null, + 'capture_voice_recording' => null, + 'capture_voice_recording_metadata' => null, + 'cfr_use_wide_image' => null, + 'cfr_use_wide_image_metadata' => null, + 'check_for_multiple_admins_on_account' => null, + 'check_for_multiple_admins_on_account_metadata' => null, + 'chrome_signature_enabled' => null, + 'chrome_signature_enabled_metadata' => null, + 'comment_email_show_message_text' => null, + 'comment_email_show_message_text_metadata' => null, + 'comments_allow_envelope_override' => null, + 'comments_allow_envelope_override_metadata' => null, + 'conditional_fields_enabled' => null, + 'conditional_fields_enabled_metadata' => null, + 'consumer_disclosure_frequency' => null, + 'consumer_disclosure_frequency_metadata' => null, + 'convert_pdf_fields' => null, + 'convert_pdf_fields_metadata' => null, + 'data_population_scope' => null, + 'data_population_scope_metadata' => null, + 'disable_mobile_app' => null, + 'disable_mobile_app_metadata' => null, + 'disable_mobile_push_notifications' => null, + 'disable_mobile_push_notifications_metadata' => null, + 'disable_mobile_sending' => null, + 'disable_mobile_sending_metadata' => null, + 'disable_multiple_sessions' => null, + 'disable_multiple_sessions_metadata' => null, + 'disable_purge_notifications_for_sender_metadata' => null, + 'disable_signer_cert_view' => null, + 'disable_signer_cert_view_metadata' => null, + 'disable_signer_history_view' => null, + 'disable_signer_history_view_metadata' => null, + 'disable_style_signature' => null, + 'disable_style_signature_metadata' => null, + 'disable_upload_signature' => null, + 'disable_upload_signature_metadata' => null, + 'disable_user_sharing' => null, + 'disable_user_sharing_metadata' => null, + 'display_beta_switch' => null, + 'display_beta_switch_metadata' => null, + 'document_conversion_restrictions' => null, + 'document_conversion_restrictions_metadata' => null, + 'document_retention' => null, + 'document_retention_metadata' => null, + 'document_retention_purge_tabs' => null, + 'document_visibility' => null, + 'document_visibility_metadata' => null, + 'email_template_version' => null, + 'email_template_version_metadata' => null, + 'enable_access_code_generator' => null, + 'enable_access_code_generator_metadata' => null, + 'enable_advanced_payments' => null, + 'enable_advanced_payments_metadata' => null, + 'enable_advanced_power_forms' => null, + 'enable_advanced_power_forms_metadata' => null, + 'enable_auto_nav' => null, + 'enable_auto_nav_metadata' => null, + 'enable_calculated_fields' => null, + 'enable_calculated_fields_metadata' => null, + 'enable_clickwraps' => null, + 'enable_clickwraps_metadata' => null, + 'enable_comments_history_download_in_signing' => null, + 'enable_comments_history_download_in_signing_metadata' => null, + 'enable_customer_satisfaction_metric_tracking' => null, + 'enable_customer_satisfaction_metric_tracking_metadata' => null, + 'enable_ds_pro' => null, + 'enable_ds_pro_metadata' => null, + 'enable_envelope_stamping_by_account_admin' => null, + 'enable_envelope_stamping_by_account_admin_metadata' => null, + 'enable_envelope_stamping_by_ds_admin' => null, + 'enable_envelope_stamping_by_ds_admin_metadata' => null, + 'enable_in_browser_editor' => null, + 'enable_in_browser_editor_metadata' => null, + 'enable_payment_processing' => null, + 'enable_payment_processing_metadata' => null, + 'enable_power_form' => null, + 'enable_power_form_direct' => null, + 'enable_power_form_direct_metadata' => null, + 'enable_power_form_metadata' => null, + 'enable_recipient_domain_validation' => null, + 'enable_recipient_domain_validation_metadata' => null, + 'enable_report_links' => null, + 'enable_report_links_metadata' => null, + 'enable_require_sign_on_paper' => null, + 'enable_require_sign_on_paper_metadata' => null, + 'enable_reserved_domain' => null, + 'enable_reserved_domain_metadata' => null, + 'enable_responsive_signing' => null, + 'enable_responsive_signing_metadata' => null, + 'enable_scheduled_release' => null, + 'enable_scheduled_release_metadata' => null, + 'enable_search_ui' => null, + 'enable_search_ui_metadata' => null, + 'enable_sending_tags_font_settings' => null, + 'enable_sending_tags_font_settings_metadata' => null, + 'enable_send_to_agent' => null, + 'enable_send_to_agent_metadata' => null, + 'enable_send_to_intermediary' => null, + 'enable_send_to_intermediary_metadata' => null, + 'enable_send_to_manage' => null, + 'enable_send_to_manage_metadata' => null, + 'enable_sequential_signing_api' => null, + 'enable_sequential_signing_api_metadata' => null, + 'enable_sequential_signing_ui' => null, + 'enable_sequential_signing_ui_metadata' => null, + 'enable_signer_attachments' => null, + 'enable_signer_attachments_metadata' => null, + 'enable_signing_extension_comments' => null, + 'enable_signing_extension_comments_metadata' => null, + 'enable_signing_extension_conversations' => null, + 'enable_signing_extension_conversations_metadata' => null, + 'enable_signing_order_settings_for_account' => null, + 'enable_signing_order_settings_for_account_metadata' => null, + 'enable_sign_on_paper' => null, + 'enable_sign_on_paper_metadata' => null, + 'enable_sign_on_paper_override' => null, + 'enable_sign_on_paper_override_metadata' => null, + 'enable_sign_with_notary' => null, + 'enable_sign_with_notary_metadata' => null, + 'enable_smart_contracts' => null, + 'enable_smart_contracts_metadata' => null, + 'enable_sms_authentication' => null, + 'enable_sms_authentication_metadata' => null, + 'enable_social_id_login' => null, + 'enable_social_id_login_metadata' => null, + 'enable_strike_through' => null, + 'enable_strike_through_metadata' => null, + 'enable_transaction_point' => null, + 'enable_transaction_point_metadata' => null, + 'enable_vaulting' => null, + 'enable_vaulting_metadata' => null, + 'enable_witnessing' => null, + 'enable_witnessing_metadata' => null, + 'enforce_template_name_uniqueness' => null, + 'enforce_template_name_uniqueness_metadata' => null, + 'envelope_integration_allowed' => null, + 'envelope_integration_allowed_metadata' => null, + 'envelope_integration_enabled' => null, + 'envelope_integration_enabled_metadata' => null, + 'envelope_stamping_default_value' => null, + 'envelope_stamping_default_value_metadata' => null, + 'express_send' => null, + 'express_send_allow_tabs' => null, + 'express_send_allow_tabs_metadata' => null, + 'express_send_metadata' => null, + 'external_document_sources' => null, + 'external_signature_pad_type' => null, + 'external_signature_pad_type_metadata' => null, + 'fax_out_enabled' => null, + 'fax_out_enabled_metadata' => null, + 'guided_forms_html_allowed' => null, + 'guided_forms_html_allowed_metadata' => null, + 'hide_account_address_in_co_c' => null, + 'hide_account_address_in_co_c_metadata' => null, + 'hide_pricing' => null, + 'hide_pricing_metadata' => null, + 'id_check_configurations' => null, + 'id_check_expire' => null, + 'id_check_expire_days' => null, + 'id_check_expire_days_metadata' => null, + 'id_check_expire_metadata' => null, + 'id_check_expire_minutes' => null, + 'id_check_expire_minutes_metadata' => null, + 'id_check_required' => null, + 'id_check_required_metadata' => null, + 'identity_verification' => null, + 'identity_verification_metadata' => null, + 'ignore_error_if_anchor_tab_not_found' => null, + 'ignore_error_if_anchor_tab_not_found_metadata_enabled' => null, + 'in_person_id_check_question' => null, + 'in_person_id_check_question_metadata' => null, + 'in_person_signing_enabled' => null, + 'in_person_signing_enabled_metadata' => null, + 'in_session_enabled' => null, + 'in_session_enabled_metadata' => null, + 'in_session_suppress_emails' => null, + 'in_session_suppress_emails_metadata' => null, + 'maximum_signing_groups' => null, + 'maximum_signing_groups_metadata' => null, + 'maximum_users_per_signing_group' => null, + 'maximum_users_per_signing_group_metadata' => null, + 'max_number_of_custom_stamps' => null, + 'mobile_session_timeout' => null, + 'mobile_session_timeout_metadata' => null, + 'number_of_active_custom_stamps' => null, + 'opt_in_mobile_signing_v02' => null, + 'opt_in_mobile_signing_v02_metadata' => null, + 'opt_out_auto_nav_text_and_tab_color_updates' => null, + 'opt_out_auto_nav_text_and_tab_color_updates_metadata' => null, + 'opt_out_new_platform_seal' => null, + 'opt_out_new_platform_seal_platform_metadata' => null, + 'phone_auth_recipient_may_provide_phone_number' => null, + 'phone_auth_recipient_may_provide_phone_number_metadata' => null, + 'pki_sign_downloaded_pdf_docs' => null, + 'pki_sign_downloaded_pdf_docs_metadata' => null, + 'recipients_can_sign_offline' => null, + 'recipients_can_sign_offline_metadata' => null, + 'recipient_signing_auto_navigation_control' => null, + 'recipient_signing_auto_navigation_control_metadata' => null, + 'require21_cf_rpt11_compliance' => null, + 'require21_cf_rpt11_compliance_metadata' => null, + 'require_decline_reason' => null, + 'require_decline_reason_metadata' => null, + 'require_external_user_management' => null, + 'require_external_user_management_metadata' => null, + 'require_signer_certificate_type' => null, + 'require_signer_certificate_type_metadata' => null, + 'rsa_verid_account_name' => null, + 'rsa_verid_password' => null, + 'rsa_verid_ruleset' => null, + 'rsa_verid_user_id' => null, + 'self_signed_recipient_email_document' => null, + 'self_signed_recipient_email_document_metadata' => null, + 'self_signed_recipient_email_document_user_override' => null, + 'self_signed_recipient_email_document_user_override_metadata' => null, + 'sender_can_sign_in_each_location' => null, + 'sender_can_sign_in_each_location_metadata' => null, + 'sender_must_authenticate_signing' => null, + 'sender_must_authenticate_signing_metadata' => null, + 'sending_tags_font_color' => null, + 'sending_tags_font_color_metadata' => null, + 'sending_tags_font_name' => null, + 'sending_tags_font_name_metadata' => null, + 'sending_tags_font_size' => null, + 'sending_tags_font_size_metadata' => null, + 'send_to_certified_delivery_enabled' => null, + 'send_to_certified_delivery_enabled_metadata' => null, + 'session_timeout' => null, + 'session_timeout_metadata' => null, + 'set_recip_email_lang' => null, + 'set_recip_email_lang_metadata' => null, + 'set_recip_sign_lang' => null, + 'set_recip_sign_lang_metadata' => null, + 'shared_template_folders' => null, + 'shared_template_folders_metadata' => null, + 'show_complete_dialog_in_embedded_session' => null, + 'show_complete_dialog_in_embedded_session_metadata' => null, + 'show_conditional_routing_on_send' => null, + 'show_conditional_routing_on_send_metadata' => null, + 'show_initial_conditional_fields' => null, + 'show_initial_conditional_fields_metadata' => null, + 'show_localized_watermarks' => null, + 'show_localized_watermarks_metadata' => null, + 'show_tutorials' => null, + 'show_tutorials_metadata' => null, + 'signature_providers' => null, + 'signature_providers_metadata' => null, + 'sign_date_format' => null, + 'sign_date_format_metadata' => null, + 'signer_attach_certificate_to_envelope_pdf' => null, + 'signer_attach_certificate_to_envelope_pdf_metadata' => null, + 'signer_attach_concat' => null, + 'signer_attach_concat_metadata' => null, + 'signer_can_create_account' => null, + 'signer_can_create_account_metadata' => null, + 'signer_can_sign_on_mobile' => null, + 'signer_can_sign_on_mobile_metadata' => null, + 'signer_in_session_use_envelope_complete_email' => null, + 'signer_in_session_use_envelope_complete_email_metadata' => null, + 'signer_login_requirements' => null, + 'signer_login_requirements_metadata' => null, + 'signer_must_have_account' => null, + 'signer_must_have_account_metadata' => null, + 'signer_must_login_to_sign' => null, + 'signer_must_login_to_sign_metadata' => null, + 'signer_show_secure_field_initial_values' => null, + 'signer_show_secure_field_initial_values_metadata' => null, + 'signing_session_timeout' => null, + 'signing_session_timeout_metadata' => null, + 'signing_ui_version' => null, + 'signing_ui_version_metadata' => null, + 'sign_time_format' => null, + 'sign_time_format_metadata' => null, + 'sign_time_show_am_pm' => null, + 'sign_time_show_am_pm_metadata' => null, + 'simplified_sending_enabled' => null, + 'simplified_sending_enabled_metadata' => null, + 'single_sign_on_enabled' => null, + 'single_sign_on_enabled_metadata' => null, + 'skip_auth_completed_envelopes' => null, + 'skip_auth_completed_envelopes_metadata' => null, + 'social_id_recip_auth' => null, + 'social_id_recip_auth_metadata' => null, + 'specify_document_visibility' => null, + 'specify_document_visibility_metadata' => null, + 'start_in_advanced_correct' => null, + 'start_in_advanced_correct_metadata' => null, + 'supplemental_documents_must_accept' => null, + 'supplemental_documents_must_accept_metadata' => null, + 'supplemental_documents_must_read' => null, + 'supplemental_documents_must_read_metadata' => null, + 'supplemental_documents_must_view' => null, + 'supplemental_documents_must_view_metadata' => null, + 'suppress_certificate_enforcement' => null, + 'suppress_certificate_enforcement_metadata' => null, + 'tab_account_settings' => null, + 'timezone_offset_api' => null, + 'timezone_offset_api_metadata' => null, + 'timezone_offset_ui' => null, + 'timezone_offset_ui_metadata' => null, + 'universal_signature_opt_in' => null, + 'use_account_level_email' => null, + 'use_account_level_email_metadata' => null, + 'use_consumer_disclosure' => null, + 'use_consumer_disclosure_metadata' => null, + 'use_consumer_disclosure_within_account' => null, + 'use_consumer_disclosure_within_account_metadata' => null, + 'use_derived_keys' => null, + 'use_derived_keys_metadata' => null, + 'use_docu_sign_express_signer_certificate' => null, + 'use_docu_sign_express_signer_certificate_metadata' => null, + 'use_multi_app_groups_data' => null, + 'use_multi_app_groups_data_metadata' => null, + 'use_new_blob_for_pdf' => null, + 'use_new_blob_for_pdf_metadata' => null, + 'use_safe_signer_certificates' => null, + 'use_safe_signer_certificates_metadata' => null, + 'uses_api' => null, + 'uses_api_metadata' => null, + 'use_signature_provider_platform' => null, + 'use_signature_provider_platform_metadata' => null, + 'validations_allowed' => null, + 'validations_allowed_metadata' => null, + 'validations_brand' => null, + 'validations_brand_metadata' => null, + 'validations_cadence' => null, + 'validations_cadence_metadata' => null, + 'validations_enabled' => null, + 'validations_enabled_metadata' => null, + 'validations_report' => null, + 'validations_report_metadata' => null, + 'water_mark_enabled' => null, + 'water_mark_enabled_metadata' => null, + 'write_reminder_to_envelope_history' => null, + 'write_reminder_to_envelope_history_metadata' => null, + 'wurfl_min_allowable_screen_size' => null, + 'wurfl_min_allowable_screen_size_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -1097,9 +1639,9 @@ public static function swaggerTypes() 'wurfl_min_allowable_screen_size_metadata' => 'wurflMinAllowableScreenSizeMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -1619,9 +2161,9 @@ public static function swaggerTypes() 'wurfl_min_allowable_screen_size_metadata' => 'setWurflMinAllowableScreenSizeMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -2141,34 +2683,63 @@ public static function swaggerTypes() 'wurfl_min_allowable_screen_size_metadata' => 'getWurflMinAllowableScreenSizeMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -2689,30 +3260,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code_format + * * @return \DocuSign\eSign\Model\AccessCodeFormat */ public function getAccessCodeFormat() @@ -2722,7 +3295,9 @@ public function getAccessCodeFormat() /** * Sets access_code_format - * @param \DocuSign\eSign\Model\AccessCodeFormat $access_code_format + * + * @param \DocuSign\eSign\Model\AccessCodeFormat $access_code_format access_code_format + * * @return $this */ public function setAccessCodeFormat($access_code_format) @@ -2734,6 +3309,7 @@ public function setAccessCodeFormat($access_code_format) /** * Gets account_date_time_format + * * @return string */ public function getAccountDateTimeFormat() @@ -2743,7 +3319,9 @@ public function getAccountDateTimeFormat() /** * Sets account_date_time_format + * * @param string $account_date_time_format + * * @return $this */ public function setAccountDateTimeFormat($account_date_time_format) @@ -2755,6 +3333,7 @@ public function setAccountDateTimeFormat($account_date_time_format) /** * Gets account_date_time_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAccountDateTimeFormatMetadata() @@ -2764,7 +3343,9 @@ public function getAccountDateTimeFormatMetadata() /** * Sets account_date_time_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $account_date_time_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $account_date_time_format_metadata account_date_time_format_metadata + * * @return $this */ public function setAccountDateTimeFormatMetadata($account_date_time_format_metadata) @@ -2776,6 +3357,7 @@ public function setAccountDateTimeFormatMetadata($account_date_time_format_metad /** * Gets account_name + * * @return string */ public function getAccountName() @@ -2785,7 +3367,9 @@ public function getAccountName() /** * Sets account_name + * * @param string $account_name + * * @return $this */ public function setAccountName($account_name) @@ -2797,6 +3381,7 @@ public function setAccountName($account_name) /** * Gets account_name_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAccountNameMetadata() @@ -2806,7 +3391,9 @@ public function getAccountNameMetadata() /** * Sets account_name_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $account_name_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $account_name_metadata account_name_metadata + * * @return $this */ public function setAccountNameMetadata($account_name_metadata) @@ -2818,6 +3405,7 @@ public function setAccountNameMetadata($account_name_metadata) /** * Gets account_notification + * * @return \DocuSign\eSign\Model\AccountNotification */ public function getAccountNotification() @@ -2827,7 +3415,9 @@ public function getAccountNotification() /** * Sets account_notification - * @param \DocuSign\eSign\Model\AccountNotification $account_notification + * + * @param \DocuSign\eSign\Model\AccountNotification $account_notification account_notification + * * @return $this */ public function setAccountNotification($account_notification) @@ -2839,6 +3429,7 @@ public function setAccountNotification($account_notification) /** * Gets account_ui_settings + * * @return \DocuSign\eSign\Model\AccountUISettings */ public function getAccountUiSettings() @@ -2848,7 +3439,9 @@ public function getAccountUiSettings() /** * Sets account_ui_settings - * @param \DocuSign\eSign\Model\AccountUISettings $account_ui_settings + * + * @param \DocuSign\eSign\Model\AccountUISettings $account_ui_settings account_ui_settings + * * @return $this */ public function setAccountUiSettings($account_ui_settings) @@ -2860,6 +3453,7 @@ public function setAccountUiSettings($account_ui_settings) /** * Gets adopt_sig_config + * * @return string */ public function getAdoptSigConfig() @@ -2869,7 +3463,9 @@ public function getAdoptSigConfig() /** * Sets adopt_sig_config + * * @param string $adopt_sig_config + * * @return $this */ public function setAdoptSigConfig($adopt_sig_config) @@ -2881,6 +3477,7 @@ public function setAdoptSigConfig($adopt_sig_config) /** * Gets adopt_sig_config_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAdoptSigConfigMetadata() @@ -2890,7 +3487,9 @@ public function getAdoptSigConfigMetadata() /** * Sets adopt_sig_config_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $adopt_sig_config_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $adopt_sig_config_metadata adopt_sig_config_metadata + * * @return $this */ public function setAdoptSigConfigMetadata($adopt_sig_config_metadata) @@ -2902,6 +3501,7 @@ public function setAdoptSigConfigMetadata($adopt_sig_config_metadata) /** * Gets advanced_correct + * * @return string */ public function getAdvancedCorrect() @@ -2911,7 +3511,9 @@ public function getAdvancedCorrect() /** * Sets advanced_correct + * * @param string $advanced_correct + * * @return $this */ public function setAdvancedCorrect($advanced_correct) @@ -2923,6 +3525,7 @@ public function setAdvancedCorrect($advanced_correct) /** * Gets advanced_correct_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAdvancedCorrectMetadata() @@ -2932,7 +3535,9 @@ public function getAdvancedCorrectMetadata() /** * Sets advanced_correct_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $advanced_correct_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $advanced_correct_metadata advanced_correct_metadata + * * @return $this */ public function setAdvancedCorrectMetadata($advanced_correct_metadata) @@ -2944,6 +3549,7 @@ public function setAdvancedCorrectMetadata($advanced_correct_metadata) /** * Gets allow_access_code_format + * * @return string */ public function getAllowAccessCodeFormat() @@ -2953,7 +3559,9 @@ public function getAllowAccessCodeFormat() /** * Sets allow_access_code_format + * * @param string $allow_access_code_format + * * @return $this */ public function setAllowAccessCodeFormat($allow_access_code_format) @@ -2965,6 +3573,7 @@ public function setAllowAccessCodeFormat($allow_access_code_format) /** * Gets allow_access_code_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAccessCodeFormatMetadata() @@ -2974,7 +3583,9 @@ public function getAllowAccessCodeFormatMetadata() /** * Sets allow_access_code_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_access_code_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_access_code_format_metadata allow_access_code_format_metadata + * * @return $this */ public function setAllowAccessCodeFormatMetadata($allow_access_code_format_metadata) @@ -2986,6 +3597,7 @@ public function setAllowAccessCodeFormatMetadata($allow_access_code_format_metad /** * Gets allow_account_management_granular + * * @return string */ public function getAllowAccountManagementGranular() @@ -2995,7 +3607,9 @@ public function getAllowAccountManagementGranular() /** * Sets allow_account_management_granular + * * @param string $allow_account_management_granular + * * @return $this */ public function setAllowAccountManagementGranular($allow_account_management_granular) @@ -3007,6 +3621,7 @@ public function setAllowAccountManagementGranular($allow_account_management_gran /** * Gets allow_account_management_granular_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAccountManagementGranularMetadata() @@ -3016,7 +3631,9 @@ public function getAllowAccountManagementGranularMetadata() /** * Sets allow_account_management_granular_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_account_management_granular_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_account_management_granular_metadata allow_account_management_granular_metadata + * * @return $this */ public function setAllowAccountManagementGranularMetadata($allow_account_management_granular_metadata) @@ -3028,6 +3645,7 @@ public function setAllowAccountManagementGranularMetadata($allow_account_managem /** * Gets allow_account_member_name_change + * * @return string */ public function getAllowAccountMemberNameChange() @@ -3037,7 +3655,9 @@ public function getAllowAccountMemberNameChange() /** * Sets allow_account_member_name_change + * * @param string $allow_account_member_name_change + * * @return $this */ public function setAllowAccountMemberNameChange($allow_account_member_name_change) @@ -3049,6 +3669,7 @@ public function setAllowAccountMemberNameChange($allow_account_member_name_chang /** * Gets allow_account_member_name_change_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAccountMemberNameChangeMetadata() @@ -3058,7 +3679,9 @@ public function getAllowAccountMemberNameChangeMetadata() /** * Sets allow_account_member_name_change_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_account_member_name_change_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_account_member_name_change_metadata allow_account_member_name_change_metadata + * * @return $this */ public function setAllowAccountMemberNameChangeMetadata($allow_account_member_name_change_metadata) @@ -3070,6 +3693,7 @@ public function setAllowAccountMemberNameChangeMetadata($allow_account_member_na /** * Gets allow_advanced_recipient_routing_conditional + * * @return string */ public function getAllowAdvancedRecipientRoutingConditional() @@ -3079,7 +3703,9 @@ public function getAllowAdvancedRecipientRoutingConditional() /** * Sets allow_advanced_recipient_routing_conditional + * * @param string $allow_advanced_recipient_routing_conditional + * * @return $this */ public function setAllowAdvancedRecipientRoutingConditional($allow_advanced_recipient_routing_conditional) @@ -3091,6 +3717,7 @@ public function setAllowAdvancedRecipientRoutingConditional($allow_advanced_reci /** * Gets allow_advanced_recipient_routing_conditional_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAdvancedRecipientRoutingConditionalMetadata() @@ -3100,7 +3727,9 @@ public function getAllowAdvancedRecipientRoutingConditionalMetadata() /** * Sets allow_advanced_recipient_routing_conditional_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_advanced_recipient_routing_conditional_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_advanced_recipient_routing_conditional_metadata allow_advanced_recipient_routing_conditional_metadata + * * @return $this */ public function setAllowAdvancedRecipientRoutingConditionalMetadata($allow_advanced_recipient_routing_conditional_metadata) @@ -3112,6 +3741,7 @@ public function setAllowAdvancedRecipientRoutingConditionalMetadata($allow_advan /** * Gets allow_agent_name_email_edit + * * @return string */ public function getAllowAgentNameEmailEdit() @@ -3121,7 +3751,9 @@ public function getAllowAgentNameEmailEdit() /** * Sets allow_agent_name_email_edit + * * @param string $allow_agent_name_email_edit + * * @return $this */ public function setAllowAgentNameEmailEdit($allow_agent_name_email_edit) @@ -3133,6 +3765,7 @@ public function setAllowAgentNameEmailEdit($allow_agent_name_email_edit) /** * Gets allow_agent_name_email_edit_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAgentNameEmailEditMetadata() @@ -3142,7 +3775,9 @@ public function getAllowAgentNameEmailEditMetadata() /** * Sets allow_agent_name_email_edit_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_agent_name_email_edit_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_agent_name_email_edit_metadata allow_agent_name_email_edit_metadata + * * @return $this */ public function setAllowAgentNameEmailEditMetadata($allow_agent_name_email_edit_metadata) @@ -3154,6 +3789,7 @@ public function setAllowAgentNameEmailEditMetadata($allow_agent_name_email_edit_ /** * Gets allow_agreement_actions + * * @return string */ public function getAllowAgreementActions() @@ -3163,7 +3799,9 @@ public function getAllowAgreementActions() /** * Sets allow_agreement_actions + * * @param string $allow_agreement_actions + * * @return $this */ public function setAllowAgreementActions($allow_agreement_actions) @@ -3175,6 +3813,7 @@ public function setAllowAgreementActions($allow_agreement_actions) /** * Gets allow_agreement_actions_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAgreementActionsMetadata() @@ -3184,7 +3823,9 @@ public function getAllowAgreementActionsMetadata() /** * Sets allow_agreement_actions_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_agreement_actions_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_agreement_actions_metadata allow_agreement_actions_metadata + * * @return $this */ public function setAllowAgreementActionsMetadata($allow_agreement_actions_metadata) @@ -3196,6 +3837,7 @@ public function setAllowAgreementActionsMetadata($allow_agreement_actions_metada /** * Gets allow_auto_nav_settings + * * @return string */ public function getAllowAutoNavSettings() @@ -3205,7 +3847,9 @@ public function getAllowAutoNavSettings() /** * Sets allow_auto_nav_settings + * * @param string $allow_auto_nav_settings + * * @return $this */ public function setAllowAutoNavSettings($allow_auto_nav_settings) @@ -3217,6 +3861,7 @@ public function setAllowAutoNavSettings($allow_auto_nav_settings) /** * Gets allow_auto_nav_settings_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAutoNavSettingsMetadata() @@ -3226,7 +3871,9 @@ public function getAllowAutoNavSettingsMetadata() /** * Sets allow_auto_nav_settings_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_auto_nav_settings_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_auto_nav_settings_metadata allow_auto_nav_settings_metadata + * * @return $this */ public function setAllowAutoNavSettingsMetadata($allow_auto_nav_settings_metadata) @@ -3238,6 +3885,7 @@ public function setAllowAutoNavSettingsMetadata($allow_auto_nav_settings_metadat /** * Gets allow_auto_tagging + * * @return string */ public function getAllowAutoTagging() @@ -3247,7 +3895,9 @@ public function getAllowAutoTagging() /** * Sets allow_auto_tagging + * * @param string $allow_auto_tagging + * * @return $this */ public function setAllowAutoTagging($allow_auto_tagging) @@ -3259,6 +3909,7 @@ public function setAllowAutoTagging($allow_auto_tagging) /** * Gets allow_auto_tagging_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAutoTaggingMetadata() @@ -3268,7 +3919,9 @@ public function getAllowAutoTaggingMetadata() /** * Sets allow_auto_tagging_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_auto_tagging_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_auto_tagging_metadata allow_auto_tagging_metadata + * * @return $this */ public function setAllowAutoTaggingMetadata($allow_auto_tagging_metadata) @@ -3280,6 +3933,7 @@ public function setAllowAutoTaggingMetadata($allow_auto_tagging_metadata) /** * Gets allow_bulk_send + * * @return string */ public function getAllowBulkSend() @@ -3289,7 +3943,9 @@ public function getAllowBulkSend() /** * Sets allow_bulk_send + * * @param string $allow_bulk_send + * * @return $this */ public function setAllowBulkSend($allow_bulk_send) @@ -3301,6 +3957,7 @@ public function setAllowBulkSend($allow_bulk_send) /** * Gets allow_bulk_send_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowBulkSendMetadata() @@ -3310,7 +3967,9 @@ public function getAllowBulkSendMetadata() /** * Sets allow_bulk_send_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_bulk_send_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_bulk_send_metadata allow_bulk_send_metadata + * * @return $this */ public function setAllowBulkSendMetadata($allow_bulk_send_metadata) @@ -3322,6 +3981,7 @@ public function setAllowBulkSendMetadata($allow_bulk_send_metadata) /** * Gets allow_cd_withdraw + * * @return string */ public function getAllowCdWithdraw() @@ -3331,7 +3991,9 @@ public function getAllowCdWithdraw() /** * Sets allow_cd_withdraw + * * @param string $allow_cd_withdraw + * * @return $this */ public function setAllowCdWithdraw($allow_cd_withdraw) @@ -3343,6 +4005,7 @@ public function setAllowCdWithdraw($allow_cd_withdraw) /** * Gets allow_cd_withdraw_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowCdWithdrawMetadata() @@ -3352,7 +4015,9 @@ public function getAllowCdWithdrawMetadata() /** * Sets allow_cd_withdraw_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_cd_withdraw_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_cd_withdraw_metadata allow_cd_withdraw_metadata + * * @return $this */ public function setAllowCdWithdrawMetadata($allow_cd_withdraw_metadata) @@ -3364,6 +4029,7 @@ public function setAllowCdWithdrawMetadata($allow_cd_withdraw_metadata) /** * Gets allow_connect_http_listener_configs + * * @return string */ public function getAllowConnectHttpListenerConfigs() @@ -3373,7 +4039,9 @@ public function getAllowConnectHttpListenerConfigs() /** * Sets allow_connect_http_listener_configs + * * @param string $allow_connect_http_listener_configs + * * @return $this */ public function setAllowConnectHttpListenerConfigs($allow_connect_http_listener_configs) @@ -3385,6 +4053,7 @@ public function setAllowConnectHttpListenerConfigs($allow_connect_http_listener_ /** * Gets allow_connect_send_finish_later + * * @return string */ public function getAllowConnectSendFinishLater() @@ -3394,7 +4063,9 @@ public function getAllowConnectSendFinishLater() /** * Sets allow_connect_send_finish_later + * * @param string $allow_connect_send_finish_later + * * @return $this */ public function setAllowConnectSendFinishLater($allow_connect_send_finish_later) @@ -3406,6 +4077,7 @@ public function setAllowConnectSendFinishLater($allow_connect_send_finish_later) /** * Gets allow_connect_send_finish_later_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowConnectSendFinishLaterMetadata() @@ -3415,7 +4087,9 @@ public function getAllowConnectSendFinishLaterMetadata() /** * Sets allow_connect_send_finish_later_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_connect_send_finish_later_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_connect_send_finish_later_metadata allow_connect_send_finish_later_metadata + * * @return $this */ public function setAllowConnectSendFinishLaterMetadata($allow_connect_send_finish_later_metadata) @@ -3427,6 +4101,7 @@ public function setAllowConnectSendFinishLaterMetadata($allow_connect_send_finis /** * Gets allow_consumer_disclosure_override + * * @return string */ public function getAllowConsumerDisclosureOverride() @@ -3436,7 +4111,9 @@ public function getAllowConsumerDisclosureOverride() /** * Sets allow_consumer_disclosure_override + * * @param string $allow_consumer_disclosure_override + * * @return $this */ public function setAllowConsumerDisclosureOverride($allow_consumer_disclosure_override) @@ -3448,6 +4125,7 @@ public function setAllowConsumerDisclosureOverride($allow_consumer_disclosure_ov /** * Gets allow_consumer_disclosure_override_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowConsumerDisclosureOverrideMetadata() @@ -3457,7 +4135,9 @@ public function getAllowConsumerDisclosureOverrideMetadata() /** * Sets allow_consumer_disclosure_override_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_consumer_disclosure_override_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_consumer_disclosure_override_metadata allow_consumer_disclosure_override_metadata + * * @return $this */ public function setAllowConsumerDisclosureOverrideMetadata($allow_consumer_disclosure_override_metadata) @@ -3469,6 +4149,7 @@ public function setAllowConsumerDisclosureOverrideMetadata($allow_consumer_discl /** * Gets allow_data_download + * * @return string */ public function getAllowDataDownload() @@ -3478,7 +4159,9 @@ public function getAllowDataDownload() /** * Sets allow_data_download + * * @param string $allow_data_download + * * @return $this */ public function setAllowDataDownload($allow_data_download) @@ -3490,6 +4173,7 @@ public function setAllowDataDownload($allow_data_download) /** * Gets allow_data_download_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowDataDownloadMetadata() @@ -3499,7 +4183,9 @@ public function getAllowDataDownloadMetadata() /** * Sets allow_data_download_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_data_download_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_data_download_metadata allow_data_download_metadata + * * @return $this */ public function setAllowDataDownloadMetadata($allow_data_download_metadata) @@ -3511,6 +4197,7 @@ public function setAllowDataDownloadMetadata($allow_data_download_metadata) /** * Gets allow_document_disclosures + * * @return string */ public function getAllowDocumentDisclosures() @@ -3520,7 +4207,9 @@ public function getAllowDocumentDisclosures() /** * Sets allow_document_disclosures + * * @param string $allow_document_disclosures + * * @return $this */ public function setAllowDocumentDisclosures($allow_document_disclosures) @@ -3532,6 +4221,7 @@ public function setAllowDocumentDisclosures($allow_document_disclosures) /** * Gets allow_document_disclosures_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowDocumentDisclosuresMetadata() @@ -3541,7 +4231,9 @@ public function getAllowDocumentDisclosuresMetadata() /** * Sets allow_document_disclosures_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_document_disclosures_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_document_disclosures_metadata allow_document_disclosures_metadata + * * @return $this */ public function setAllowDocumentDisclosuresMetadata($allow_document_disclosures_metadata) @@ -3553,6 +4245,7 @@ public function setAllowDocumentDisclosuresMetadata($allow_document_disclosures_ /** * Gets allow_documents_on_signed_envelopes + * * @return string */ public function getAllowDocumentsOnSignedEnvelopes() @@ -3562,7 +4255,9 @@ public function getAllowDocumentsOnSignedEnvelopes() /** * Sets allow_documents_on_signed_envelopes + * * @param string $allow_documents_on_signed_envelopes + * * @return $this */ public function setAllowDocumentsOnSignedEnvelopes($allow_documents_on_signed_envelopes) @@ -3574,6 +4269,7 @@ public function setAllowDocumentsOnSignedEnvelopes($allow_documents_on_signed_en /** * Gets allow_documents_on_signed_envelopes_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowDocumentsOnSignedEnvelopesMetadata() @@ -3583,7 +4279,9 @@ public function getAllowDocumentsOnSignedEnvelopesMetadata() /** * Sets allow_documents_on_signed_envelopes_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_documents_on_signed_envelopes_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_documents_on_signed_envelopes_metadata allow_documents_on_signed_envelopes_metadata + * * @return $this */ public function setAllowDocumentsOnSignedEnvelopesMetadata($allow_documents_on_signed_envelopes_metadata) @@ -3595,6 +4293,7 @@ public function setAllowDocumentsOnSignedEnvelopesMetadata($allow_documents_on_s /** * Gets allow_document_visibility + * * @return string */ public function getAllowDocumentVisibility() @@ -3604,7 +4303,9 @@ public function getAllowDocumentVisibility() /** * Sets allow_document_visibility + * * @param string $allow_document_visibility + * * @return $this */ public function setAllowDocumentVisibility($allow_document_visibility) @@ -3616,6 +4317,7 @@ public function setAllowDocumentVisibility($allow_document_visibility) /** * Gets allow_document_visibility_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowDocumentVisibilityMetadata() @@ -3625,7 +4327,9 @@ public function getAllowDocumentVisibilityMetadata() /** * Sets allow_document_visibility_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_document_visibility_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_document_visibility_metadata allow_document_visibility_metadata + * * @return $this */ public function setAllowDocumentVisibilityMetadata($allow_document_visibility_metadata) @@ -3637,6 +4341,7 @@ public function setAllowDocumentVisibilityMetadata($allow_document_visibility_me /** * Gets allow_e_hanko_stamps + * * @return string */ public function getAllowEHankoStamps() @@ -3646,7 +4351,9 @@ public function getAllowEHankoStamps() /** * Sets allow_e_hanko_stamps + * * @param string $allow_e_hanko_stamps + * * @return $this */ public function setAllowEHankoStamps($allow_e_hanko_stamps) @@ -3658,6 +4365,7 @@ public function setAllowEHankoStamps($allow_e_hanko_stamps) /** * Gets allow_e_hanko_stamps_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEHankoStampsMetadata() @@ -3667,7 +4375,9 @@ public function getAllowEHankoStampsMetadata() /** * Sets allow_e_hanko_stamps_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_e_hanko_stamps_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_e_hanko_stamps_metadata allow_e_hanko_stamps_metadata + * * @return $this */ public function setAllowEHankoStampsMetadata($allow_e_hanko_stamps_metadata) @@ -3679,6 +4389,7 @@ public function setAllowEHankoStampsMetadata($allow_e_hanko_stamps_metadata) /** * Gets allow_e_note_e_original + * * @return string */ public function getAllowENoteEOriginal() @@ -3688,7 +4399,9 @@ public function getAllowENoteEOriginal() /** * Sets allow_e_note_e_original + * * @param string $allow_e_note_e_original + * * @return $this */ public function setAllowENoteEOriginal($allow_e_note_e_original) @@ -3700,6 +4413,7 @@ public function setAllowENoteEOriginal($allow_e_note_e_original) /** * Gets allow_e_note_e_original_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowENoteEOriginalMetadata() @@ -3709,7 +4423,9 @@ public function getAllowENoteEOriginalMetadata() /** * Sets allow_e_note_e_original_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_e_note_e_original_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_e_note_e_original_metadata allow_e_note_e_original_metadata + * * @return $this */ public function setAllowENoteEOriginalMetadata($allow_e_note_e_original_metadata) @@ -3721,6 +4437,7 @@ public function setAllowENoteEOriginalMetadata($allow_e_note_e_original_metadata /** * Gets allow_envelope_correct + * * @return string */ public function getAllowEnvelopeCorrect() @@ -3730,7 +4447,9 @@ public function getAllowEnvelopeCorrect() /** * Sets allow_envelope_correct + * * @param string $allow_envelope_correct + * * @return $this */ public function setAllowEnvelopeCorrect($allow_envelope_correct) @@ -3742,6 +4461,7 @@ public function setAllowEnvelopeCorrect($allow_envelope_correct) /** * Gets allow_envelope_correct_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEnvelopeCorrectMetadata() @@ -3751,7 +4471,9 @@ public function getAllowEnvelopeCorrectMetadata() /** * Sets allow_envelope_correct_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_correct_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_correct_metadata allow_envelope_correct_metadata + * * @return $this */ public function setAllowEnvelopeCorrectMetadata($allow_envelope_correct_metadata) @@ -3763,6 +4485,7 @@ public function setAllowEnvelopeCorrectMetadata($allow_envelope_correct_metadata /** * Gets allow_envelope_custody_transfer + * * @return string */ public function getAllowEnvelopeCustodyTransfer() @@ -3772,7 +4495,9 @@ public function getAllowEnvelopeCustodyTransfer() /** * Sets allow_envelope_custody_transfer + * * @param string $allow_envelope_custody_transfer + * * @return $this */ public function setAllowEnvelopeCustodyTransfer($allow_envelope_custody_transfer) @@ -3784,6 +4509,7 @@ public function setAllowEnvelopeCustodyTransfer($allow_envelope_custody_transfer /** * Gets allow_envelope_custody_transfer_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEnvelopeCustodyTransferMetadata() @@ -3793,7 +4519,9 @@ public function getAllowEnvelopeCustodyTransferMetadata() /** * Sets allow_envelope_custody_transfer_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_custody_transfer_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_custody_transfer_metadata allow_envelope_custody_transfer_metadata + * * @return $this */ public function setAllowEnvelopeCustodyTransferMetadata($allow_envelope_custody_transfer_metadata) @@ -3805,6 +4533,7 @@ public function setAllowEnvelopeCustodyTransferMetadata($allow_envelope_custody_ /** * Gets allow_envelope_custom_fields + * * @return string */ public function getAllowEnvelopeCustomFields() @@ -3814,7 +4543,9 @@ public function getAllowEnvelopeCustomFields() /** * Sets allow_envelope_custom_fields + * * @param string $allow_envelope_custom_fields + * * @return $this */ public function setAllowEnvelopeCustomFields($allow_envelope_custom_fields) @@ -3826,6 +4557,7 @@ public function setAllowEnvelopeCustomFields($allow_envelope_custom_fields) /** * Gets allow_envelope_custom_fields_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEnvelopeCustomFieldsMetadata() @@ -3835,7 +4567,9 @@ public function getAllowEnvelopeCustomFieldsMetadata() /** * Sets allow_envelope_custom_fields_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_custom_fields_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_custom_fields_metadata allow_envelope_custom_fields_metadata + * * @return $this */ public function setAllowEnvelopeCustomFieldsMetadata($allow_envelope_custom_fields_metadata) @@ -3847,6 +4581,7 @@ public function setAllowEnvelopeCustomFieldsMetadata($allow_envelope_custom_fiel /** * Gets allow_envelope_publish_reporting + * * @return string */ public function getAllowEnvelopePublishReporting() @@ -3856,7 +4591,9 @@ public function getAllowEnvelopePublishReporting() /** * Sets allow_envelope_publish_reporting + * * @param string $allow_envelope_publish_reporting + * * @return $this */ public function setAllowEnvelopePublishReporting($allow_envelope_publish_reporting) @@ -3868,6 +4605,7 @@ public function setAllowEnvelopePublishReporting($allow_envelope_publish_reporti /** * Gets allow_envelope_publish_reporting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEnvelopePublishReportingMetadata() @@ -3877,7 +4615,9 @@ public function getAllowEnvelopePublishReportingMetadata() /** * Sets allow_envelope_publish_reporting_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_publish_reporting_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_publish_reporting_metadata allow_envelope_publish_reporting_metadata + * * @return $this */ public function setAllowEnvelopePublishReportingMetadata($allow_envelope_publish_reporting_metadata) @@ -3889,6 +4629,7 @@ public function setAllowEnvelopePublishReportingMetadata($allow_envelope_publish /** * Gets allow_envelope_reporting + * * @return string */ public function getAllowEnvelopeReporting() @@ -3898,7 +4639,9 @@ public function getAllowEnvelopeReporting() /** * Sets allow_envelope_reporting + * * @param string $allow_envelope_reporting + * * @return $this */ public function setAllowEnvelopeReporting($allow_envelope_reporting) @@ -3910,6 +4653,7 @@ public function setAllowEnvelopeReporting($allow_envelope_reporting) /** * Gets allow_envelope_reporting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEnvelopeReportingMetadata() @@ -3919,7 +4663,9 @@ public function getAllowEnvelopeReportingMetadata() /** * Sets allow_envelope_reporting_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_reporting_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_reporting_metadata allow_envelope_reporting_metadata + * * @return $this */ public function setAllowEnvelopeReportingMetadata($allow_envelope_reporting_metadata) @@ -3931,6 +4677,7 @@ public function setAllowEnvelopeReportingMetadata($allow_envelope_reporting_meta /** * Gets allow_expression + * * @return string */ public function getAllowExpression() @@ -3940,7 +4687,9 @@ public function getAllowExpression() /** * Sets allow_expression + * * @param string $allow_expression + * * @return $this */ public function setAllowExpression($allow_expression) @@ -3952,6 +4701,7 @@ public function setAllowExpression($allow_expression) /** * Gets allow_expression_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowExpressionMetadata() @@ -3961,7 +4711,9 @@ public function getAllowExpressionMetadata() /** * Sets allow_expression_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_expression_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_expression_metadata allow_expression_metadata + * * @return $this */ public function setAllowExpressionMetadata($allow_expression_metadata) @@ -3973,6 +4725,7 @@ public function setAllowExpressionMetadata($allow_expression_metadata) /** * Gets allow_express_signer_certificate + * * @return string */ public function getAllowExpressSignerCertificate() @@ -3982,7 +4735,9 @@ public function getAllowExpressSignerCertificate() /** * Sets allow_express_signer_certificate + * * @param string $allow_express_signer_certificate + * * @return $this */ public function setAllowExpressSignerCertificate($allow_express_signer_certificate) @@ -3994,6 +4749,7 @@ public function setAllowExpressSignerCertificate($allow_express_signer_certifica /** * Gets allow_express_signer_certificate_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowExpressSignerCertificateMetadata() @@ -4003,7 +4759,9 @@ public function getAllowExpressSignerCertificateMetadata() /** * Sets allow_express_signer_certificate_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_express_signer_certificate_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_express_signer_certificate_metadata allow_express_signer_certificate_metadata + * * @return $this */ public function setAllowExpressSignerCertificateMetadata($allow_express_signer_certificate_metadata) @@ -4015,6 +4773,7 @@ public function setAllowExpressSignerCertificateMetadata($allow_express_signer_c /** * Gets allow_extended_sending_resource_file + * * @return string */ public function getAllowExtendedSendingResourceFile() @@ -4024,7 +4783,9 @@ public function getAllowExtendedSendingResourceFile() /** * Sets allow_extended_sending_resource_file + * * @param string $allow_extended_sending_resource_file + * * @return $this */ public function setAllowExtendedSendingResourceFile($allow_extended_sending_resource_file) @@ -4036,6 +4797,7 @@ public function setAllowExtendedSendingResourceFile($allow_extended_sending_reso /** * Gets allow_extended_sending_resource_file_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowExtendedSendingResourceFileMetadata() @@ -4045,7 +4807,9 @@ public function getAllowExtendedSendingResourceFileMetadata() /** * Sets allow_extended_sending_resource_file_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_extended_sending_resource_file_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_extended_sending_resource_file_metadata allow_extended_sending_resource_file_metadata + * * @return $this */ public function setAllowExtendedSendingResourceFileMetadata($allow_extended_sending_resource_file_metadata) @@ -4057,6 +4821,7 @@ public function setAllowExtendedSendingResourceFileMetadata($allow_extended_send /** * Gets allow_external_signature_pad + * * @return string */ public function getAllowExternalSignaturePad() @@ -4066,7 +4831,9 @@ public function getAllowExternalSignaturePad() /** * Sets allow_external_signature_pad + * * @param string $allow_external_signature_pad + * * @return $this */ public function setAllowExternalSignaturePad($allow_external_signature_pad) @@ -4078,6 +4845,7 @@ public function setAllowExternalSignaturePad($allow_external_signature_pad) /** * Gets allow_external_signature_pad_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowExternalSignaturePadMetadata() @@ -4087,7 +4855,9 @@ public function getAllowExternalSignaturePadMetadata() /** * Sets allow_external_signature_pad_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_external_signature_pad_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_external_signature_pad_metadata allow_external_signature_pad_metadata + * * @return $this */ public function setAllowExternalSignaturePadMetadata($allow_external_signature_pad_metadata) @@ -4099,6 +4869,7 @@ public function setAllowExternalSignaturePadMetadata($allow_external_signature_p /** * Gets allow_idv_level1 + * * @return string */ public function getAllowIdvLevel1() @@ -4108,7 +4879,9 @@ public function getAllowIdvLevel1() /** * Sets allow_idv_level1 + * * @param string $allow_idv_level1 + * * @return $this */ public function setAllowIdvLevel1($allow_idv_level1) @@ -4120,6 +4893,7 @@ public function setAllowIdvLevel1($allow_idv_level1) /** * Gets allow_idv_level1_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowIdvLevel1Metadata() @@ -4129,7 +4903,9 @@ public function getAllowIdvLevel1Metadata() /** * Sets allow_idv_level1_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_idv_level1_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_idv_level1_metadata allow_idv_level1_metadata + * * @return $this */ public function setAllowIdvLevel1Metadata($allow_idv_level1_metadata) @@ -4141,6 +4917,7 @@ public function setAllowIdvLevel1Metadata($allow_idv_level1_metadata) /** * Gets allow_idv_platform + * * @return string */ public function getAllowIdvPlatform() @@ -4150,7 +4927,9 @@ public function getAllowIdvPlatform() /** * Sets allow_idv_platform + * * @param string $allow_idv_platform + * * @return $this */ public function setAllowIdvPlatform($allow_idv_platform) @@ -4162,6 +4941,7 @@ public function setAllowIdvPlatform($allow_idv_platform) /** * Gets allow_idv_platform_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowIdvPlatformMetadata() @@ -4171,7 +4951,9 @@ public function getAllowIdvPlatformMetadata() /** * Sets allow_idv_platform_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_idv_platform_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_idv_platform_metadata allow_idv_platform_metadata + * * @return $this */ public function setAllowIdvPlatformMetadata($allow_idv_platform_metadata) @@ -4183,6 +4965,7 @@ public function setAllowIdvPlatformMetadata($allow_idv_platform_metadata) /** * Gets allow_in_person + * * @return string */ public function getAllowInPerson() @@ -4192,7 +4975,9 @@ public function getAllowInPerson() /** * Sets allow_in_person + * * @param string $allow_in_person + * * @return $this */ public function setAllowInPerson($allow_in_person) @@ -4204,6 +4989,7 @@ public function setAllowInPerson($allow_in_person) /** * Gets allow_in_person_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowInPersonMetadata() @@ -4213,8 +4999,10 @@ public function getAllowInPersonMetadata() /** * Sets allow_in_person_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_in_person_metadata - * @return $this + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_in_person_metadata allow_in_person_metadata + * + * @return $this */ public function setAllowInPersonMetadata($allow_in_person_metadata) { @@ -4225,6 +5013,7 @@ public function setAllowInPersonMetadata($allow_in_person_metadata) /** * Gets allow_managed_stamps + * * @return string */ public function getAllowManagedStamps() @@ -4234,7 +5023,9 @@ public function getAllowManagedStamps() /** * Sets allow_managed_stamps + * * @param string $allow_managed_stamps + * * @return $this */ public function setAllowManagedStamps($allow_managed_stamps) @@ -4246,6 +5037,7 @@ public function setAllowManagedStamps($allow_managed_stamps) /** * Gets allow_managed_stamps_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowManagedStampsMetadata() @@ -4255,7 +5047,9 @@ public function getAllowManagedStampsMetadata() /** * Sets allow_managed_stamps_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_managed_stamps_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_managed_stamps_metadata allow_managed_stamps_metadata + * * @return $this */ public function setAllowManagedStampsMetadata($allow_managed_stamps_metadata) @@ -4267,6 +5061,7 @@ public function setAllowManagedStampsMetadata($allow_managed_stamps_metadata) /** * Gets allow_markup + * * @return string */ public function getAllowMarkup() @@ -4276,7 +5071,9 @@ public function getAllowMarkup() /** * Sets allow_markup + * * @param string $allow_markup When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this + * * @return $this */ public function setAllowMarkup($allow_markup) @@ -4288,6 +5085,7 @@ public function setAllowMarkup($allow_markup) /** * Gets allow_markup_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowMarkupMetadata() @@ -4297,7 +5095,9 @@ public function getAllowMarkupMetadata() /** * Sets allow_markup_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_markup_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_markup_metadata allow_markup_metadata + * * @return $this */ public function setAllowMarkupMetadata($allow_markup_metadata) @@ -4309,6 +5109,7 @@ public function setAllowMarkupMetadata($allow_markup_metadata) /** * Gets allow_member_time_zone + * * @return string */ public function getAllowMemberTimeZone() @@ -4318,7 +5119,9 @@ public function getAllowMemberTimeZone() /** * Sets allow_member_time_zone + * * @param string $allow_member_time_zone + * * @return $this */ public function setAllowMemberTimeZone($allow_member_time_zone) @@ -4330,6 +5133,7 @@ public function setAllowMemberTimeZone($allow_member_time_zone) /** * Gets allow_member_time_zone_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowMemberTimeZoneMetadata() @@ -4339,7 +5143,9 @@ public function getAllowMemberTimeZoneMetadata() /** * Sets allow_member_time_zone_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_member_time_zone_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_member_time_zone_metadata allow_member_time_zone_metadata + * * @return $this */ public function setAllowMemberTimeZoneMetadata($allow_member_time_zone_metadata) @@ -4351,6 +5157,7 @@ public function setAllowMemberTimeZoneMetadata($allow_member_time_zone_metadata) /** * Gets allow_merge_fields + * * @return string */ public function getAllowMergeFields() @@ -4360,7 +5167,9 @@ public function getAllowMergeFields() /** * Sets allow_merge_fields + * * @param string $allow_merge_fields + * * @return $this */ public function setAllowMergeFields($allow_merge_fields) @@ -4372,6 +5181,7 @@ public function setAllowMergeFields($allow_merge_fields) /** * Gets allow_merge_fields_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowMergeFieldsMetadata() @@ -4381,7 +5191,9 @@ public function getAllowMergeFieldsMetadata() /** * Sets allow_merge_fields_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_merge_fields_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_merge_fields_metadata allow_merge_fields_metadata + * * @return $this */ public function setAllowMergeFieldsMetadata($allow_merge_fields_metadata) @@ -4393,6 +5205,7 @@ public function setAllowMergeFieldsMetadata($allow_merge_fields_metadata) /** * Gets allow_multiple_brand_profiles + * * @return string */ public function getAllowMultipleBrandProfiles() @@ -4402,7 +5215,9 @@ public function getAllowMultipleBrandProfiles() /** * Sets allow_multiple_brand_profiles + * * @param string $allow_multiple_brand_profiles + * * @return $this */ public function setAllowMultipleBrandProfiles($allow_multiple_brand_profiles) @@ -4414,6 +5229,7 @@ public function setAllowMultipleBrandProfiles($allow_multiple_brand_profiles) /** * Gets allow_multiple_brand_profiles_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowMultipleBrandProfilesMetadata() @@ -4423,7 +5239,9 @@ public function getAllowMultipleBrandProfilesMetadata() /** * Sets allow_multiple_brand_profiles_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_multiple_brand_profiles_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_multiple_brand_profiles_metadata allow_multiple_brand_profiles_metadata + * * @return $this */ public function setAllowMultipleBrandProfilesMetadata($allow_multiple_brand_profiles_metadata) @@ -4435,6 +5253,7 @@ public function setAllowMultipleBrandProfilesMetadata($allow_multiple_brand_prof /** * Gets allow_multiple_signer_attachments + * * @return string */ public function getAllowMultipleSignerAttachments() @@ -4444,7 +5263,9 @@ public function getAllowMultipleSignerAttachments() /** * Sets allow_multiple_signer_attachments + * * @param string $allow_multiple_signer_attachments + * * @return $this */ public function setAllowMultipleSignerAttachments($allow_multiple_signer_attachments) @@ -4456,6 +5277,7 @@ public function setAllowMultipleSignerAttachments($allow_multiple_signer_attachm /** * Gets allow_multiple_signer_attachments_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowMultipleSignerAttachmentsMetadata() @@ -4465,7 +5287,9 @@ public function getAllowMultipleSignerAttachmentsMetadata() /** * Sets allow_multiple_signer_attachments_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_multiple_signer_attachments_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_multiple_signer_attachments_metadata allow_multiple_signer_attachments_metadata + * * @return $this */ public function setAllowMultipleSignerAttachmentsMetadata($allow_multiple_signer_attachments_metadata) @@ -4477,6 +5301,7 @@ public function setAllowMultipleSignerAttachmentsMetadata($allow_multiple_signer /** * Gets allow_non_us_phone_auth + * * @return string */ public function getAllowNonUsPhoneAuth() @@ -4486,7 +5311,9 @@ public function getAllowNonUsPhoneAuth() /** * Sets allow_non_us_phone_auth + * * @param string $allow_non_us_phone_auth + * * @return $this */ public function setAllowNonUsPhoneAuth($allow_non_us_phone_auth) @@ -4498,6 +5325,7 @@ public function setAllowNonUsPhoneAuth($allow_non_us_phone_auth) /** * Gets allow_non_us_phone_auth_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowNonUsPhoneAuthMetadata() @@ -4507,7 +5335,9 @@ public function getAllowNonUsPhoneAuthMetadata() /** * Sets allow_non_us_phone_auth_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_non_us_phone_auth_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_non_us_phone_auth_metadata allow_non_us_phone_auth_metadata + * * @return $this */ public function setAllowNonUsPhoneAuthMetadata($allow_non_us_phone_auth_metadata) @@ -4519,6 +5349,7 @@ public function setAllowNonUsPhoneAuthMetadata($allow_non_us_phone_auth_metadata /** * Gets allow_ocr_of_envelope_documents + * * @return string */ public function getAllowOcrOfEnvelopeDocuments() @@ -4528,7 +5359,9 @@ public function getAllowOcrOfEnvelopeDocuments() /** * Sets allow_ocr_of_envelope_documents + * * @param string $allow_ocr_of_envelope_documents + * * @return $this */ public function setAllowOcrOfEnvelopeDocuments($allow_ocr_of_envelope_documents) @@ -4540,6 +5373,7 @@ public function setAllowOcrOfEnvelopeDocuments($allow_ocr_of_envelope_documents) /** * Gets allow_ocr_of_envelope_documents_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowOcrOfEnvelopeDocumentsMetadata() @@ -4549,7 +5383,9 @@ public function getAllowOcrOfEnvelopeDocumentsMetadata() /** * Sets allow_ocr_of_envelope_documents_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_ocr_of_envelope_documents_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_ocr_of_envelope_documents_metadata allow_ocr_of_envelope_documents_metadata + * * @return $this */ public function setAllowOcrOfEnvelopeDocumentsMetadata($allow_ocr_of_envelope_documents_metadata) @@ -4561,6 +5397,7 @@ public function setAllowOcrOfEnvelopeDocumentsMetadata($allow_ocr_of_envelope_do /** * Gets allow_offline_signing + * * @return string */ public function getAllowOfflineSigning() @@ -4570,7 +5407,9 @@ public function getAllowOfflineSigning() /** * Sets allow_offline_signing + * * @param string $allow_offline_signing + * * @return $this */ public function setAllowOfflineSigning($allow_offline_signing) @@ -4582,6 +5421,7 @@ public function setAllowOfflineSigning($allow_offline_signing) /** * Gets allow_offline_signing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowOfflineSigningMetadata() @@ -4591,7 +5431,9 @@ public function getAllowOfflineSigningMetadata() /** * Sets allow_offline_signing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_offline_signing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_offline_signing_metadata allow_offline_signing_metadata + * * @return $this */ public function setAllowOfflineSigningMetadata($allow_offline_signing_metadata) @@ -4603,6 +5445,7 @@ public function setAllowOfflineSigningMetadata($allow_offline_signing_metadata) /** * Gets allow_open_trust_signer_certificate + * * @return string */ public function getAllowOpenTrustSignerCertificate() @@ -4612,7 +5455,9 @@ public function getAllowOpenTrustSignerCertificate() /** * Sets allow_open_trust_signer_certificate + * * @param string $allow_open_trust_signer_certificate + * * @return $this */ public function setAllowOpenTrustSignerCertificate($allow_open_trust_signer_certificate) @@ -4624,6 +5469,7 @@ public function setAllowOpenTrustSignerCertificate($allow_open_trust_signer_cert /** * Gets allow_open_trust_signer_certificate_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowOpenTrustSignerCertificateMetadata() @@ -4633,7 +5479,9 @@ public function getAllowOpenTrustSignerCertificateMetadata() /** * Sets allow_open_trust_signer_certificate_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_open_trust_signer_certificate_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_open_trust_signer_certificate_metadata allow_open_trust_signer_certificate_metadata + * * @return $this */ public function setAllowOpenTrustSignerCertificateMetadata($allow_open_trust_signer_certificate_metadata) @@ -4645,6 +5493,7 @@ public function setAllowOpenTrustSignerCertificateMetadata($allow_open_trust_sig /** * Gets allow_organizations + * * @return string */ public function getAllowOrganizations() @@ -4654,7 +5503,9 @@ public function getAllowOrganizations() /** * Sets allow_organizations + * * @param string $allow_organizations + * * @return $this */ public function setAllowOrganizations($allow_organizations) @@ -4666,6 +5517,7 @@ public function setAllowOrganizations($allow_organizations) /** * Gets allow_organizations_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowOrganizationsMetadata() @@ -4675,7 +5527,9 @@ public function getAllowOrganizationsMetadata() /** * Sets allow_organizations_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_organizations_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_organizations_metadata allow_organizations_metadata + * * @return $this */ public function setAllowOrganizationsMetadata($allow_organizations_metadata) @@ -4687,6 +5541,7 @@ public function setAllowOrganizationsMetadata($allow_organizations_metadata) /** * Gets allow_payment_processing + * * @return string */ public function getAllowPaymentProcessing() @@ -4696,7 +5551,9 @@ public function getAllowPaymentProcessing() /** * Sets allow_payment_processing + * * @param string $allow_payment_processing + * * @return $this */ public function setAllowPaymentProcessing($allow_payment_processing) @@ -4708,6 +5565,7 @@ public function setAllowPaymentProcessing($allow_payment_processing) /** * Gets allow_payment_processing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowPaymentProcessingMetadata() @@ -4717,7 +5575,9 @@ public function getAllowPaymentProcessingMetadata() /** * Sets allow_payment_processing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_payment_processing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_payment_processing_metadata allow_payment_processing_metadata + * * @return $this */ public function setAllowPaymentProcessingMetadata($allow_payment_processing_metadata) @@ -4729,6 +5589,7 @@ public function setAllowPaymentProcessingMetadata($allow_payment_processing_meta /** * Gets allow_personal_signer_certificate + * * @return string */ public function getAllowPersonalSignerCertificate() @@ -4738,7 +5599,9 @@ public function getAllowPersonalSignerCertificate() /** * Sets allow_personal_signer_certificate + * * @param string $allow_personal_signer_certificate + * * @return $this */ public function setAllowPersonalSignerCertificate($allow_personal_signer_certificate) @@ -4750,6 +5613,7 @@ public function setAllowPersonalSignerCertificate($allow_personal_signer_certifi /** * Gets allow_personal_signer_certificate_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowPersonalSignerCertificateMetadata() @@ -4759,7 +5623,9 @@ public function getAllowPersonalSignerCertificateMetadata() /** * Sets allow_personal_signer_certificate_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_personal_signer_certificate_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_personal_signer_certificate_metadata allow_personal_signer_certificate_metadata + * * @return $this */ public function setAllowPersonalSignerCertificateMetadata($allow_personal_signer_certificate_metadata) @@ -4771,6 +5637,7 @@ public function setAllowPersonalSignerCertificateMetadata($allow_personal_signer /** * Gets allow_phone_authentication + * * @return string */ public function getAllowPhoneAuthentication() @@ -4780,7 +5647,9 @@ public function getAllowPhoneAuthentication() /** * Sets allow_phone_authentication + * * @param string $allow_phone_authentication + * * @return $this */ public function setAllowPhoneAuthentication($allow_phone_authentication) @@ -4792,6 +5661,7 @@ public function setAllowPhoneAuthentication($allow_phone_authentication) /** * Gets allow_phone_authentication_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowPhoneAuthenticationMetadata() @@ -4801,7 +5671,9 @@ public function getAllowPhoneAuthenticationMetadata() /** * Sets allow_phone_authentication_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_phone_authentication_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_phone_authentication_metadata allow_phone_authentication_metadata + * * @return $this */ public function setAllowPhoneAuthenticationMetadata($allow_phone_authentication_metadata) @@ -4813,6 +5685,7 @@ public function setAllowPhoneAuthenticationMetadata($allow_phone_authentication_ /** * Gets allow_phone_auth_override + * * @return string */ public function getAllowPhoneAuthOverride() @@ -4822,7 +5695,9 @@ public function getAllowPhoneAuthOverride() /** * Sets allow_phone_auth_override + * * @param string $allow_phone_auth_override + * * @return $this */ public function setAllowPhoneAuthOverride($allow_phone_auth_override) @@ -4834,6 +5709,7 @@ public function setAllowPhoneAuthOverride($allow_phone_auth_override) /** * Gets allow_phone_auth_override_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowPhoneAuthOverrideMetadata() @@ -4843,7 +5719,9 @@ public function getAllowPhoneAuthOverrideMetadata() /** * Sets allow_phone_auth_override_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_phone_auth_override_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_phone_auth_override_metadata allow_phone_auth_override_metadata + * * @return $this */ public function setAllowPhoneAuthOverrideMetadata($allow_phone_auth_override_metadata) @@ -4855,6 +5733,7 @@ public function setAllowPhoneAuthOverrideMetadata($allow_phone_auth_override_met /** * Gets allow_private_signing_groups + * * @return string */ public function getAllowPrivateSigningGroups() @@ -4864,7 +5743,9 @@ public function getAllowPrivateSigningGroups() /** * Sets allow_private_signing_groups + * * @param string $allow_private_signing_groups + * * @return $this */ public function setAllowPrivateSigningGroups($allow_private_signing_groups) @@ -4876,6 +5757,7 @@ public function setAllowPrivateSigningGroups($allow_private_signing_groups) /** * Gets allow_private_signing_groups_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowPrivateSigningGroupsMetadata() @@ -4885,7 +5767,9 @@ public function getAllowPrivateSigningGroupsMetadata() /** * Sets allow_private_signing_groups_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_private_signing_groups_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_private_signing_groups_metadata allow_private_signing_groups_metadata + * * @return $this */ public function setAllowPrivateSigningGroupsMetadata($allow_private_signing_groups_metadata) @@ -4897,6 +5781,7 @@ public function setAllowPrivateSigningGroupsMetadata($allow_private_signing_grou /** * Gets allow_reminders + * * @return string */ public function getAllowReminders() @@ -4906,7 +5791,9 @@ public function getAllowReminders() /** * Sets allow_reminders + * * @param string $allow_reminders + * * @return $this */ public function setAllowReminders($allow_reminders) @@ -4918,6 +5805,7 @@ public function setAllowReminders($allow_reminders) /** * Gets allow_reminders_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowRemindersMetadata() @@ -4927,7 +5815,9 @@ public function getAllowRemindersMetadata() /** * Sets allow_reminders_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_reminders_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_reminders_metadata allow_reminders_metadata + * * @return $this */ public function setAllowRemindersMetadata($allow_reminders_metadata) @@ -4939,6 +5829,7 @@ public function setAllowRemindersMetadata($allow_reminders_metadata) /** * Gets allow_resource_file_branding + * * @return string */ public function getAllowResourceFileBranding() @@ -4948,7 +5839,9 @@ public function getAllowResourceFileBranding() /** * Sets allow_resource_file_branding + * * @param string $allow_resource_file_branding + * * @return $this */ public function setAllowResourceFileBranding($allow_resource_file_branding) @@ -4960,6 +5853,7 @@ public function setAllowResourceFileBranding($allow_resource_file_branding) /** * Gets allow_resource_file_branding_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowResourceFileBrandingMetadata() @@ -4969,7 +5863,9 @@ public function getAllowResourceFileBrandingMetadata() /** * Sets allow_resource_file_branding_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_resource_file_branding_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_resource_file_branding_metadata allow_resource_file_branding_metadata + * * @return $this */ public function setAllowResourceFileBrandingMetadata($allow_resource_file_branding_metadata) @@ -4981,6 +5877,7 @@ public function setAllowResourceFileBrandingMetadata($allow_resource_file_brandi /** * Gets allow_safe_bio_pharma_signer_certificate + * * @return string */ public function getAllowSafeBioPharmaSignerCertificate() @@ -4990,7 +5887,9 @@ public function getAllowSafeBioPharmaSignerCertificate() /** * Sets allow_safe_bio_pharma_signer_certificate + * * @param string $allow_safe_bio_pharma_signer_certificate + * * @return $this */ public function setAllowSafeBioPharmaSignerCertificate($allow_safe_bio_pharma_signer_certificate) @@ -5002,6 +5901,7 @@ public function setAllowSafeBioPharmaSignerCertificate($allow_safe_bio_pharma_si /** * Gets allow_safe_bio_pharma_signer_certificate_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSafeBioPharmaSignerCertificateMetadata() @@ -5011,7 +5911,9 @@ public function getAllowSafeBioPharmaSignerCertificateMetadata() /** * Sets allow_safe_bio_pharma_signer_certificate_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_safe_bio_pharma_signer_certificate_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_safe_bio_pharma_signer_certificate_metadata allow_safe_bio_pharma_signer_certificate_metadata + * * @return $this */ public function setAllowSafeBioPharmaSignerCertificateMetadata($allow_safe_bio_pharma_signer_certificate_metadata) @@ -5023,6 +5925,7 @@ public function setAllowSafeBioPharmaSignerCertificateMetadata($allow_safe_bio_p /** * Gets allow_security_appliance + * * @return string */ public function getAllowSecurityAppliance() @@ -5032,7 +5935,9 @@ public function getAllowSecurityAppliance() /** * Sets allow_security_appliance + * * @param string $allow_security_appliance + * * @return $this */ public function setAllowSecurityAppliance($allow_security_appliance) @@ -5044,6 +5949,7 @@ public function setAllowSecurityAppliance($allow_security_appliance) /** * Gets allow_security_appliance_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSecurityApplianceMetadata() @@ -5053,7 +5959,9 @@ public function getAllowSecurityApplianceMetadata() /** * Sets allow_security_appliance_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_security_appliance_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_security_appliance_metadata allow_security_appliance_metadata + * * @return $this */ public function setAllowSecurityApplianceMetadata($allow_security_appliance_metadata) @@ -5065,6 +5973,7 @@ public function setAllowSecurityApplianceMetadata($allow_security_appliance_meta /** * Gets allow_send_to_certified_delivery + * * @return string */ public function getAllowSendToCertifiedDelivery() @@ -5074,7 +5983,9 @@ public function getAllowSendToCertifiedDelivery() /** * Sets allow_send_to_certified_delivery + * * @param string $allow_send_to_certified_delivery + * * @return $this */ public function setAllowSendToCertifiedDelivery($allow_send_to_certified_delivery) @@ -5086,6 +5997,7 @@ public function setAllowSendToCertifiedDelivery($allow_send_to_certified_deliver /** * Gets allow_send_to_certified_delivery_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSendToCertifiedDeliveryMetadata() @@ -5095,7 +6007,9 @@ public function getAllowSendToCertifiedDeliveryMetadata() /** * Sets allow_send_to_certified_delivery_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_send_to_certified_delivery_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_send_to_certified_delivery_metadata allow_send_to_certified_delivery_metadata + * * @return $this */ public function setAllowSendToCertifiedDeliveryMetadata($allow_send_to_certified_delivery_metadata) @@ -5107,6 +6021,7 @@ public function setAllowSendToCertifiedDeliveryMetadata($allow_send_to_certified /** * Gets allow_send_to_intermediary + * * @return string */ public function getAllowSendToIntermediary() @@ -5116,7 +6031,9 @@ public function getAllowSendToIntermediary() /** * Sets allow_send_to_intermediary + * * @param string $allow_send_to_intermediary + * * @return $this */ public function setAllowSendToIntermediary($allow_send_to_intermediary) @@ -5128,6 +6045,7 @@ public function setAllowSendToIntermediary($allow_send_to_intermediary) /** * Gets allow_send_to_intermediary_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSendToIntermediaryMetadata() @@ -5137,7 +6055,9 @@ public function getAllowSendToIntermediaryMetadata() /** * Sets allow_send_to_intermediary_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_send_to_intermediary_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_send_to_intermediary_metadata allow_send_to_intermediary_metadata + * * @return $this */ public function setAllowSendToIntermediaryMetadata($allow_send_to_intermediary_metadata) @@ -5149,6 +6069,7 @@ public function setAllowSendToIntermediaryMetadata($allow_send_to_intermediary_m /** * Gets allow_server_templates + * * @return string */ public function getAllowServerTemplates() @@ -5158,7 +6079,9 @@ public function getAllowServerTemplates() /** * Sets allow_server_templates + * * @param string $allow_server_templates + * * @return $this */ public function setAllowServerTemplates($allow_server_templates) @@ -5170,6 +6093,7 @@ public function setAllowServerTemplates($allow_server_templates) /** * Gets allow_server_templates_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowServerTemplatesMetadata() @@ -5179,7 +6103,9 @@ public function getAllowServerTemplatesMetadata() /** * Sets allow_server_templates_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_server_templates_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_server_templates_metadata allow_server_templates_metadata + * * @return $this */ public function setAllowServerTemplatesMetadata($allow_server_templates_metadata) @@ -5191,6 +6117,7 @@ public function setAllowServerTemplatesMetadata($allow_server_templates_metadata /** * Gets allow_set_embedded_recipient_start_url + * * @return string */ public function getAllowSetEmbeddedRecipientStartUrl() @@ -5200,7 +6127,9 @@ public function getAllowSetEmbeddedRecipientStartUrl() /** * Sets allow_set_embedded_recipient_start_url + * * @param string $allow_set_embedded_recipient_start_url + * * @return $this */ public function setAllowSetEmbeddedRecipientStartUrl($allow_set_embedded_recipient_start_url) @@ -5212,6 +6141,7 @@ public function setAllowSetEmbeddedRecipientStartUrl($allow_set_embedded_recipie /** * Gets allow_set_embedded_recipient_start_url_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSetEmbeddedRecipientStartUrlMetadata() @@ -5221,7 +6151,9 @@ public function getAllowSetEmbeddedRecipientStartUrlMetadata() /** * Sets allow_set_embedded_recipient_start_url_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_set_embedded_recipient_start_url_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_set_embedded_recipient_start_url_metadata allow_set_embedded_recipient_start_url_metadata + * * @return $this */ public function setAllowSetEmbeddedRecipientStartUrlMetadata($allow_set_embedded_recipient_start_url_metadata) @@ -5233,6 +6165,7 @@ public function setAllowSetEmbeddedRecipientStartUrlMetadata($allow_set_embedded /** * Gets allow_shared_tabs + * * @return string */ public function getAllowSharedTabs() @@ -5242,7 +6175,9 @@ public function getAllowSharedTabs() /** * Sets allow_shared_tabs + * * @param string $allow_shared_tabs + * * @return $this */ public function setAllowSharedTabs($allow_shared_tabs) @@ -5254,6 +6189,7 @@ public function setAllowSharedTabs($allow_shared_tabs) /** * Gets allow_shared_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSharedTabsMetadata() @@ -5263,7 +6199,9 @@ public function getAllowSharedTabsMetadata() /** * Sets allow_shared_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_shared_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_shared_tabs_metadata allow_shared_tabs_metadata + * * @return $this */ public function setAllowSharedTabsMetadata($allow_shared_tabs_metadata) @@ -5275,6 +6213,7 @@ public function setAllowSharedTabsMetadata($allow_shared_tabs_metadata) /** * Gets allow_signature_stamps + * * @return string */ public function getAllowSignatureStamps() @@ -5284,7 +6223,9 @@ public function getAllowSignatureStamps() /** * Sets allow_signature_stamps + * * @param string $allow_signature_stamps + * * @return $this */ public function setAllowSignatureStamps($allow_signature_stamps) @@ -5296,6 +6237,7 @@ public function setAllowSignatureStamps($allow_signature_stamps) /** * Gets allow_signature_stamps_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSignatureStampsMetadata() @@ -5305,7 +6247,9 @@ public function getAllowSignatureStampsMetadata() /** * Sets allow_signature_stamps_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signature_stamps_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signature_stamps_metadata allow_signature_stamps_metadata + * * @return $this */ public function setAllowSignatureStampsMetadata($allow_signature_stamps_metadata) @@ -5317,6 +6261,7 @@ public function setAllowSignatureStampsMetadata($allow_signature_stamps_metadata /** * Gets allow_sign_document_from_home_page + * * @return string */ public function getAllowSignDocumentFromHomePage() @@ -5326,7 +6271,9 @@ public function getAllowSignDocumentFromHomePage() /** * Sets allow_sign_document_from_home_page + * * @param string $allow_sign_document_from_home_page + * * @return $this */ public function setAllowSignDocumentFromHomePage($allow_sign_document_from_home_page) @@ -5338,6 +6285,7 @@ public function setAllowSignDocumentFromHomePage($allow_sign_document_from_home_ /** * Gets allow_sign_document_from_home_page_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSignDocumentFromHomePageMetadata() @@ -5347,7 +6295,9 @@ public function getAllowSignDocumentFromHomePageMetadata() /** * Sets allow_sign_document_from_home_page_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_sign_document_from_home_page_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_sign_document_from_home_page_metadata allow_sign_document_from_home_page_metadata + * * @return $this */ public function setAllowSignDocumentFromHomePageMetadata($allow_sign_document_from_home_page_metadata) @@ -5359,6 +6309,7 @@ public function setAllowSignDocumentFromHomePageMetadata($allow_sign_document_fr /** * Gets allow_signer_reassign + * * @return string */ public function getAllowSignerReassign() @@ -5368,7 +6319,9 @@ public function getAllowSignerReassign() /** * Sets allow_signer_reassign + * * @param string $allow_signer_reassign + * * @return $this */ public function setAllowSignerReassign($allow_signer_reassign) @@ -5380,6 +6333,7 @@ public function setAllowSignerReassign($allow_signer_reassign) /** * Gets allow_signer_reassign_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSignerReassignMetadata() @@ -5389,7 +6343,9 @@ public function getAllowSignerReassignMetadata() /** * Sets allow_signer_reassign_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signer_reassign_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signer_reassign_metadata allow_signer_reassign_metadata + * * @return $this */ public function setAllowSignerReassignMetadata($allow_signer_reassign_metadata) @@ -5401,6 +6357,7 @@ public function setAllowSignerReassignMetadata($allow_signer_reassign_metadata) /** * Gets allow_signer_reassign_override + * * @return string */ public function getAllowSignerReassignOverride() @@ -5410,7 +6367,9 @@ public function getAllowSignerReassignOverride() /** * Sets allow_signer_reassign_override + * * @param string $allow_signer_reassign_override + * * @return $this */ public function setAllowSignerReassignOverride($allow_signer_reassign_override) @@ -5422,6 +6381,7 @@ public function setAllowSignerReassignOverride($allow_signer_reassign_override) /** * Gets allow_signer_reassign_override_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSignerReassignOverrideMetadata() @@ -5431,7 +6391,9 @@ public function getAllowSignerReassignOverrideMetadata() /** * Sets allow_signer_reassign_override_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signer_reassign_override_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signer_reassign_override_metadata allow_signer_reassign_override_metadata + * * @return $this */ public function setAllowSignerReassignOverrideMetadata($allow_signer_reassign_override_metadata) @@ -5443,6 +6405,7 @@ public function setAllowSignerReassignOverrideMetadata($allow_signer_reassign_ov /** * Gets allow_signing_extensions + * * @return string */ public function getAllowSigningExtensions() @@ -5452,7 +6415,9 @@ public function getAllowSigningExtensions() /** * Sets allow_signing_extensions + * * @param string $allow_signing_extensions + * * @return $this */ public function setAllowSigningExtensions($allow_signing_extensions) @@ -5464,6 +6429,7 @@ public function setAllowSigningExtensions($allow_signing_extensions) /** * Gets allow_signing_extensions_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSigningExtensionsMetadata() @@ -5473,7 +6439,9 @@ public function getAllowSigningExtensionsMetadata() /** * Sets allow_signing_extensions_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signing_extensions_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signing_extensions_metadata allow_signing_extensions_metadata + * * @return $this */ public function setAllowSigningExtensionsMetadata($allow_signing_extensions_metadata) @@ -5485,6 +6453,7 @@ public function setAllowSigningExtensionsMetadata($allow_signing_extensions_meta /** * Gets allow_signing_groups + * * @return string */ public function getAllowSigningGroups() @@ -5494,7 +6463,9 @@ public function getAllowSigningGroups() /** * Sets allow_signing_groups + * * @param string $allow_signing_groups + * * @return $this */ public function setAllowSigningGroups($allow_signing_groups) @@ -5506,6 +6477,7 @@ public function setAllowSigningGroups($allow_signing_groups) /** * Gets allow_signing_groups_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSigningGroupsMetadata() @@ -5515,7 +6487,9 @@ public function getAllowSigningGroupsMetadata() /** * Sets allow_signing_groups_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signing_groups_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signing_groups_metadata allow_signing_groups_metadata + * * @return $this */ public function setAllowSigningGroupsMetadata($allow_signing_groups_metadata) @@ -5527,6 +6501,7 @@ public function setAllowSigningGroupsMetadata($allow_signing_groups_metadata) /** * Gets allow_signing_radio_deselect + * * @return string */ public function getAllowSigningRadioDeselect() @@ -5536,7 +6511,9 @@ public function getAllowSigningRadioDeselect() /** * Sets allow_signing_radio_deselect + * * @param string $allow_signing_radio_deselect + * * @return $this */ public function setAllowSigningRadioDeselect($allow_signing_radio_deselect) @@ -5548,6 +6525,7 @@ public function setAllowSigningRadioDeselect($allow_signing_radio_deselect) /** * Gets allow_signing_radio_deselect_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSigningRadioDeselectMetadata() @@ -5557,7 +6535,9 @@ public function getAllowSigningRadioDeselectMetadata() /** * Sets allow_signing_radio_deselect_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signing_radio_deselect_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_signing_radio_deselect_metadata allow_signing_radio_deselect_metadata + * * @return $this */ public function setAllowSigningRadioDeselectMetadata($allow_signing_radio_deselect_metadata) @@ -5569,6 +6549,7 @@ public function setAllowSigningRadioDeselectMetadata($allow_signing_radio_desele /** * Gets allow_sign_now + * * @return string */ public function getAllowSignNow() @@ -5578,7 +6559,9 @@ public function getAllowSignNow() /** * Sets allow_sign_now + * * @param string $allow_sign_now + * * @return $this */ public function setAllowSignNow($allow_sign_now) @@ -5590,6 +6573,7 @@ public function setAllowSignNow($allow_sign_now) /** * Gets allow_sign_now_metadata + * * @return string */ public function getAllowSignNowMetadata() @@ -5599,7 +6583,9 @@ public function getAllowSignNowMetadata() /** * Sets allow_sign_now_metadata + * * @param string $allow_sign_now_metadata + * * @return $this */ public function setAllowSignNowMetadata($allow_sign_now_metadata) @@ -5611,6 +6597,7 @@ public function setAllowSignNowMetadata($allow_sign_now_metadata) /** * Gets allow_sms_delivery + * * @return string */ public function getAllowSmsDelivery() @@ -5620,7 +6607,9 @@ public function getAllowSmsDelivery() /** * Sets allow_sms_delivery + * * @param string $allow_sms_delivery + * * @return $this */ public function setAllowSmsDelivery($allow_sms_delivery) @@ -5632,6 +6621,7 @@ public function setAllowSmsDelivery($allow_sms_delivery) /** * Gets allow_sms_delivery_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSmsDeliveryMetadata() @@ -5641,7 +6631,9 @@ public function getAllowSmsDeliveryMetadata() /** * Sets allow_sms_delivery_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_sms_delivery_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_sms_delivery_metadata allow_sms_delivery_metadata + * * @return $this */ public function setAllowSmsDeliveryMetadata($allow_sms_delivery_metadata) @@ -5653,6 +6645,7 @@ public function setAllowSmsDeliveryMetadata($allow_sms_delivery_metadata) /** * Gets allow_social_id_login + * * @return string */ public function getAllowSocialIdLogin() @@ -5662,7 +6655,9 @@ public function getAllowSocialIdLogin() /** * Sets allow_social_id_login + * * @param string $allow_social_id_login + * * @return $this */ public function setAllowSocialIdLogin($allow_social_id_login) @@ -5674,6 +6669,7 @@ public function setAllowSocialIdLogin($allow_social_id_login) /** * Gets allow_social_id_login_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSocialIdLoginMetadata() @@ -5683,7 +6679,9 @@ public function getAllowSocialIdLoginMetadata() /** * Sets allow_social_id_login_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_social_id_login_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_social_id_login_metadata allow_social_id_login_metadata + * * @return $this */ public function setAllowSocialIdLoginMetadata($allow_social_id_login_metadata) @@ -5695,6 +6693,7 @@ public function setAllowSocialIdLoginMetadata($allow_social_id_login_metadata) /** * Gets allow_supplemental_documents + * * @return string */ public function getAllowSupplementalDocuments() @@ -5704,7 +6703,9 @@ public function getAllowSupplementalDocuments() /** * Sets allow_supplemental_documents + * * @param string $allow_supplemental_documents + * * @return $this */ public function setAllowSupplementalDocuments($allow_supplemental_documents) @@ -5716,6 +6717,7 @@ public function setAllowSupplementalDocuments($allow_supplemental_documents) /** * Gets allow_supplemental_documents_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSupplementalDocumentsMetadata() @@ -5725,7 +6727,9 @@ public function getAllowSupplementalDocumentsMetadata() /** * Sets allow_supplemental_documents_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_supplemental_documents_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_supplemental_documents_metadata allow_supplemental_documents_metadata + * * @return $this */ public function setAllowSupplementalDocumentsMetadata($allow_supplemental_documents_metadata) @@ -5737,6 +6741,7 @@ public function setAllowSupplementalDocumentsMetadata($allow_supplemental_docume /** * Gets allow_users_to_access_directory + * * @return string */ public function getAllowUsersToAccessDirectory() @@ -5746,7 +6751,9 @@ public function getAllowUsersToAccessDirectory() /** * Sets allow_users_to_access_directory + * * @param string $allow_users_to_access_directory + * * @return $this */ public function setAllowUsersToAccessDirectory($allow_users_to_access_directory) @@ -5758,6 +6765,7 @@ public function setAllowUsersToAccessDirectory($allow_users_to_access_directory) /** * Gets allow_users_to_access_directory_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowUsersToAccessDirectoryMetadata() @@ -5767,7 +6775,9 @@ public function getAllowUsersToAccessDirectoryMetadata() /** * Sets allow_users_to_access_directory_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_users_to_access_directory_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_users_to_access_directory_metadata allow_users_to_access_directory_metadata + * * @return $this */ public function setAllowUsersToAccessDirectoryMetadata($allow_users_to_access_directory_metadata) @@ -5779,6 +6789,7 @@ public function setAllowUsersToAccessDirectoryMetadata($allow_users_to_access_di /** * Gets allow_value_insights + * * @return string */ public function getAllowValueInsights() @@ -5788,7 +6799,9 @@ public function getAllowValueInsights() /** * Sets allow_value_insights + * * @param string $allow_value_insights + * * @return $this */ public function setAllowValueInsights($allow_value_insights) @@ -5800,6 +6813,7 @@ public function setAllowValueInsights($allow_value_insights) /** * Gets allow_value_insights_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowValueInsightsMetadata() @@ -5809,7 +6823,9 @@ public function getAllowValueInsightsMetadata() /** * Sets allow_value_insights_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_value_insights_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_value_insights_metadata allow_value_insights_metadata + * * @return $this */ public function setAllowValueInsightsMetadata($allow_value_insights_metadata) @@ -5821,6 +6837,7 @@ public function setAllowValueInsightsMetadata($allow_value_insights_metadata) /** * Gets anchor_population_scope + * * @return string */ public function getAnchorPopulationScope() @@ -5830,7 +6847,9 @@ public function getAnchorPopulationScope() /** * Sets anchor_population_scope + * * @param string $anchor_population_scope + * * @return $this */ public function setAnchorPopulationScope($anchor_population_scope) @@ -5842,6 +6861,7 @@ public function setAnchorPopulationScope($anchor_population_scope) /** * Gets anchor_population_scope_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAnchorPopulationScopeMetadata() @@ -5851,7 +6871,9 @@ public function getAnchorPopulationScopeMetadata() /** * Sets anchor_population_scope_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $anchor_population_scope_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $anchor_population_scope_metadata anchor_population_scope_metadata + * * @return $this */ public function setAnchorPopulationScopeMetadata($anchor_population_scope_metadata) @@ -5863,6 +6885,7 @@ public function setAnchorPopulationScopeMetadata($anchor_population_scope_metada /** * Gets anchor_tag_versioned_placement_enabled + * * @return string */ public function getAnchorTagVersionedPlacementEnabled() @@ -5872,7 +6895,9 @@ public function getAnchorTagVersionedPlacementEnabled() /** * Sets anchor_tag_versioned_placement_enabled + * * @param string $anchor_tag_versioned_placement_enabled + * * @return $this */ public function setAnchorTagVersionedPlacementEnabled($anchor_tag_versioned_placement_enabled) @@ -5884,6 +6909,7 @@ public function setAnchorTagVersionedPlacementEnabled($anchor_tag_versioned_plac /** * Gets anchor_tag_versioned_placement_metadata_enabled + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAnchorTagVersionedPlacementMetadataEnabled() @@ -5893,7 +6919,9 @@ public function getAnchorTagVersionedPlacementMetadataEnabled() /** * Sets anchor_tag_versioned_placement_metadata_enabled - * @param \DocuSign\eSign\Model\SettingsMetadata $anchor_tag_versioned_placement_metadata_enabled + * + * @param \DocuSign\eSign\Model\SettingsMetadata $anchor_tag_versioned_placement_metadata_enabled anchor_tag_versioned_placement_metadata_enabled + * * @return $this */ public function setAnchorTagVersionedPlacementMetadataEnabled($anchor_tag_versioned_placement_metadata_enabled) @@ -5905,6 +6933,7 @@ public function setAnchorTagVersionedPlacementMetadataEnabled($anchor_tag_versio /** * Gets attach_completed_envelope + * * @return string */ public function getAttachCompletedEnvelope() @@ -5914,7 +6943,9 @@ public function getAttachCompletedEnvelope() /** * Sets attach_completed_envelope + * * @param string $attach_completed_envelope + * * @return $this */ public function setAttachCompletedEnvelope($attach_completed_envelope) @@ -5926,6 +6957,7 @@ public function setAttachCompletedEnvelope($attach_completed_envelope) /** * Gets attach_completed_envelope_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAttachCompletedEnvelopeMetadata() @@ -5935,7 +6967,9 @@ public function getAttachCompletedEnvelopeMetadata() /** * Sets attach_completed_envelope_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $attach_completed_envelope_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $attach_completed_envelope_metadata attach_completed_envelope_metadata + * * @return $this */ public function setAttachCompletedEnvelopeMetadata($attach_completed_envelope_metadata) @@ -5947,6 +6981,7 @@ public function setAttachCompletedEnvelopeMetadata($attach_completed_envelope_me /** * Gets authentication_check + * * @return string */ public function getAuthenticationCheck() @@ -5956,7 +6991,9 @@ public function getAuthenticationCheck() /** * Sets authentication_check + * * @param string $authentication_check + * * @return $this */ public function setAuthenticationCheck($authentication_check) @@ -5968,6 +7005,7 @@ public function setAuthenticationCheck($authentication_check) /** * Gets authentication_check_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAuthenticationCheckMetadata() @@ -5977,7 +7015,9 @@ public function getAuthenticationCheckMetadata() /** * Sets authentication_check_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $authentication_check_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $authentication_check_metadata authentication_check_metadata + * * @return $this */ public function setAuthenticationCheckMetadata($authentication_check_metadata) @@ -5989,6 +7029,7 @@ public function setAuthenticationCheckMetadata($authentication_check_metadata) /** * Gets auto_nav_rule + * * @return string */ public function getAutoNavRule() @@ -5998,7 +7039,9 @@ public function getAutoNavRule() /** * Sets auto_nav_rule + * * @param string $auto_nav_rule + * * @return $this */ public function setAutoNavRule($auto_nav_rule) @@ -6010,6 +7053,7 @@ public function setAutoNavRule($auto_nav_rule) /** * Gets auto_nav_rule_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAutoNavRuleMetadata() @@ -6019,7 +7063,9 @@ public function getAutoNavRuleMetadata() /** * Sets auto_nav_rule_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $auto_nav_rule_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $auto_nav_rule_metadata auto_nav_rule_metadata + * * @return $this */ public function setAutoNavRuleMetadata($auto_nav_rule_metadata) @@ -6031,6 +7077,7 @@ public function setAutoNavRuleMetadata($auto_nav_rule_metadata) /** * Gets auto_provision_signer_account + * * @return string */ public function getAutoProvisionSignerAccount() @@ -6040,7 +7087,9 @@ public function getAutoProvisionSignerAccount() /** * Sets auto_provision_signer_account + * * @param string $auto_provision_signer_account + * * @return $this */ public function setAutoProvisionSignerAccount($auto_provision_signer_account) @@ -6052,6 +7101,7 @@ public function setAutoProvisionSignerAccount($auto_provision_signer_account) /** * Gets auto_provision_signer_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAutoProvisionSignerAccountMetadata() @@ -6061,7 +7111,9 @@ public function getAutoProvisionSignerAccountMetadata() /** * Sets auto_provision_signer_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $auto_provision_signer_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $auto_provision_signer_account_metadata auto_provision_signer_account_metadata + * * @return $this */ public function setAutoProvisionSignerAccountMetadata($auto_provision_signer_account_metadata) @@ -6073,6 +7125,7 @@ public function setAutoProvisionSignerAccountMetadata($auto_provision_signer_acc /** * Gets bcc_email_archive + * * @return string */ public function getBccEmailArchive() @@ -6082,7 +7135,9 @@ public function getBccEmailArchive() /** * Sets bcc_email_archive + * * @param string $bcc_email_archive + * * @return $this */ public function setBccEmailArchive($bcc_email_archive) @@ -6094,6 +7149,7 @@ public function setBccEmailArchive($bcc_email_archive) /** * Gets bcc_email_archive_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getBccEmailArchiveMetadata() @@ -6103,7 +7159,9 @@ public function getBccEmailArchiveMetadata() /** * Sets bcc_email_archive_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $bcc_email_archive_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $bcc_email_archive_metadata bcc_email_archive_metadata + * * @return $this */ public function setBccEmailArchiveMetadata($bcc_email_archive_metadata) @@ -6115,6 +7173,7 @@ public function setBccEmailArchiveMetadata($bcc_email_archive_metadata) /** * Gets beta_switch_configuration + * * @return string */ public function getBetaSwitchConfiguration() @@ -6124,7 +7183,9 @@ public function getBetaSwitchConfiguration() /** * Sets beta_switch_configuration + * * @param string $beta_switch_configuration + * * @return $this */ public function setBetaSwitchConfiguration($beta_switch_configuration) @@ -6136,6 +7197,7 @@ public function setBetaSwitchConfiguration($beta_switch_configuration) /** * Gets beta_switch_configuration_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getBetaSwitchConfigurationMetadata() @@ -6145,7 +7207,9 @@ public function getBetaSwitchConfigurationMetadata() /** * Sets beta_switch_configuration_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $beta_switch_configuration_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $beta_switch_configuration_metadata beta_switch_configuration_metadata + * * @return $this */ public function setBetaSwitchConfigurationMetadata($beta_switch_configuration_metadata) @@ -6157,6 +7221,7 @@ public function setBetaSwitchConfigurationMetadata($beta_switch_configuration_me /** * Gets billing_address + * * @return \DocuSign\eSign\Model\AddressInformation */ public function getBillingAddress() @@ -6166,7 +7231,9 @@ public function getBillingAddress() /** * Sets billing_address - * @param \DocuSign\eSign\Model\AddressInformation $billing_address + * + * @param \DocuSign\eSign\Model\AddressInformation $billing_address billing_address + * * @return $this */ public function setBillingAddress($billing_address) @@ -6178,6 +7245,7 @@ public function setBillingAddress($billing_address) /** * Gets billing_address_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getBillingAddressMetadata() @@ -6187,7 +7255,9 @@ public function getBillingAddressMetadata() /** * Sets billing_address_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $billing_address_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $billing_address_metadata billing_address_metadata + * * @return $this */ public function setBillingAddressMetadata($billing_address_metadata) @@ -6199,6 +7269,7 @@ public function setBillingAddressMetadata($billing_address_metadata) /** * Gets bulk_send + * * @return string */ public function getBulkSend() @@ -6208,7 +7279,9 @@ public function getBulkSend() /** * Sets bulk_send + * * @param string $bulk_send + * * @return $this */ public function setBulkSend($bulk_send) @@ -6220,6 +7293,7 @@ public function setBulkSend($bulk_send) /** * Gets bulk_send_max_copies_in_batch + * * @return string */ public function getBulkSendMaxCopiesInBatch() @@ -6229,7 +7303,9 @@ public function getBulkSendMaxCopiesInBatch() /** * Sets bulk_send_max_copies_in_batch + * * @param string $bulk_send_max_copies_in_batch + * * @return $this */ public function setBulkSendMaxCopiesInBatch($bulk_send_max_copies_in_batch) @@ -6241,6 +7317,7 @@ public function setBulkSendMaxCopiesInBatch($bulk_send_max_copies_in_batch) /** * Gets bulk_send_max_unprocessed_envelopes_count + * * @return string */ public function getBulkSendMaxUnprocessedEnvelopesCount() @@ -6250,7 +7327,9 @@ public function getBulkSendMaxUnprocessedEnvelopesCount() /** * Sets bulk_send_max_unprocessed_envelopes_count + * * @param string $bulk_send_max_unprocessed_envelopes_count + * * @return $this */ public function setBulkSendMaxUnprocessedEnvelopesCount($bulk_send_max_unprocessed_envelopes_count) @@ -6262,6 +7341,7 @@ public function setBulkSendMaxUnprocessedEnvelopesCount($bulk_send_max_unprocess /** * Gets bulk_send_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getBulkSendMetadata() @@ -6271,7 +7351,9 @@ public function getBulkSendMetadata() /** * Sets bulk_send_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $bulk_send_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $bulk_send_metadata bulk_send_metadata + * * @return $this */ public function setBulkSendMetadata($bulk_send_metadata) @@ -6283,6 +7365,7 @@ public function setBulkSendMetadata($bulk_send_metadata) /** * Gets can_self_brand_send + * * @return string */ public function getCanSelfBrandSend() @@ -6292,7 +7375,9 @@ public function getCanSelfBrandSend() /** * Sets can_self_brand_send + * * @param string $can_self_brand_send + * * @return $this */ public function setCanSelfBrandSend($can_self_brand_send) @@ -6304,6 +7389,7 @@ public function setCanSelfBrandSend($can_self_brand_send) /** * Gets can_self_brand_send_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanSelfBrandSendMetadata() @@ -6313,7 +7399,9 @@ public function getCanSelfBrandSendMetadata() /** * Sets can_self_brand_send_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_self_brand_send_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_self_brand_send_metadata can_self_brand_send_metadata + * * @return $this */ public function setCanSelfBrandSendMetadata($can_self_brand_send_metadata) @@ -6325,6 +7413,7 @@ public function setCanSelfBrandSendMetadata($can_self_brand_send_metadata) /** * Gets can_self_brand_sign + * * @return string */ public function getCanSelfBrandSign() @@ -6334,7 +7423,9 @@ public function getCanSelfBrandSign() /** * Sets can_self_brand_sign + * * @param string $can_self_brand_sign + * * @return $this */ public function setCanSelfBrandSign($can_self_brand_sign) @@ -6346,6 +7437,7 @@ public function setCanSelfBrandSign($can_self_brand_sign) /** * Gets can_self_brand_sign_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanSelfBrandSignMetadata() @@ -6355,7 +7447,9 @@ public function getCanSelfBrandSignMetadata() /** * Sets can_self_brand_sign_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_self_brand_sign_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_self_brand_sign_metadata can_self_brand_sign_metadata + * * @return $this */ public function setCanSelfBrandSignMetadata($can_self_brand_sign_metadata) @@ -6367,6 +7461,7 @@ public function setCanSelfBrandSignMetadata($can_self_brand_sign_metadata) /** * Gets can_use_salesforce_o_auth + * * @return string */ public function getCanUseSalesforceOAuth() @@ -6376,7 +7471,9 @@ public function getCanUseSalesforceOAuth() /** * Sets can_use_salesforce_o_auth + * * @param string $can_use_salesforce_o_auth + * * @return $this */ public function setCanUseSalesforceOAuth($can_use_salesforce_o_auth) @@ -6388,6 +7485,7 @@ public function setCanUseSalesforceOAuth($can_use_salesforce_o_auth) /** * Gets can_use_salesforce_o_auth_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanUseSalesforceOAuthMetadata() @@ -6397,7 +7495,9 @@ public function getCanUseSalesforceOAuthMetadata() /** * Sets can_use_salesforce_o_auth_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_use_salesforce_o_auth_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_use_salesforce_o_auth_metadata can_use_salesforce_o_auth_metadata + * * @return $this */ public function setCanUseSalesforceOAuthMetadata($can_use_salesforce_o_auth_metadata) @@ -6409,6 +7509,7 @@ public function setCanUseSalesforceOAuthMetadata($can_use_salesforce_o_auth_meta /** * Gets capture_voice_recording + * * @return string */ public function getCaptureVoiceRecording() @@ -6418,7 +7519,9 @@ public function getCaptureVoiceRecording() /** * Sets capture_voice_recording + * * @param string $capture_voice_recording + * * @return $this */ public function setCaptureVoiceRecording($capture_voice_recording) @@ -6430,6 +7533,7 @@ public function setCaptureVoiceRecording($capture_voice_recording) /** * Gets capture_voice_recording_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCaptureVoiceRecordingMetadata() @@ -6439,7 +7543,9 @@ public function getCaptureVoiceRecordingMetadata() /** * Sets capture_voice_recording_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $capture_voice_recording_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $capture_voice_recording_metadata capture_voice_recording_metadata + * * @return $this */ public function setCaptureVoiceRecordingMetadata($capture_voice_recording_metadata) @@ -6451,6 +7557,7 @@ public function setCaptureVoiceRecordingMetadata($capture_voice_recording_metada /** * Gets cfr_use_wide_image + * * @return string */ public function getCfrUseWideImage() @@ -6460,7 +7567,9 @@ public function getCfrUseWideImage() /** * Sets cfr_use_wide_image + * * @param string $cfr_use_wide_image + * * @return $this */ public function setCfrUseWideImage($cfr_use_wide_image) @@ -6472,6 +7581,7 @@ public function setCfrUseWideImage($cfr_use_wide_image) /** * Gets cfr_use_wide_image_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCfrUseWideImageMetadata() @@ -6481,7 +7591,9 @@ public function getCfrUseWideImageMetadata() /** * Sets cfr_use_wide_image_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $cfr_use_wide_image_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $cfr_use_wide_image_metadata cfr_use_wide_image_metadata + * * @return $this */ public function setCfrUseWideImageMetadata($cfr_use_wide_image_metadata) @@ -6493,6 +7605,7 @@ public function setCfrUseWideImageMetadata($cfr_use_wide_image_metadata) /** * Gets check_for_multiple_admins_on_account + * * @return string */ public function getCheckForMultipleAdminsOnAccount() @@ -6502,7 +7615,9 @@ public function getCheckForMultipleAdminsOnAccount() /** * Sets check_for_multiple_admins_on_account + * * @param string $check_for_multiple_admins_on_account + * * @return $this */ public function setCheckForMultipleAdminsOnAccount($check_for_multiple_admins_on_account) @@ -6514,6 +7629,7 @@ public function setCheckForMultipleAdminsOnAccount($check_for_multiple_admins_on /** * Gets check_for_multiple_admins_on_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCheckForMultipleAdminsOnAccountMetadata() @@ -6523,7 +7639,9 @@ public function getCheckForMultipleAdminsOnAccountMetadata() /** * Sets check_for_multiple_admins_on_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $check_for_multiple_admins_on_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $check_for_multiple_admins_on_account_metadata check_for_multiple_admins_on_account_metadata + * * @return $this */ public function setCheckForMultipleAdminsOnAccountMetadata($check_for_multiple_admins_on_account_metadata) @@ -6535,6 +7653,7 @@ public function setCheckForMultipleAdminsOnAccountMetadata($check_for_multiple_a /** * Gets chrome_signature_enabled + * * @return string */ public function getChromeSignatureEnabled() @@ -6544,7 +7663,9 @@ public function getChromeSignatureEnabled() /** * Sets chrome_signature_enabled + * * @param string $chrome_signature_enabled + * * @return $this */ public function setChromeSignatureEnabled($chrome_signature_enabled) @@ -6556,6 +7677,7 @@ public function setChromeSignatureEnabled($chrome_signature_enabled) /** * Gets chrome_signature_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getChromeSignatureEnabledMetadata() @@ -6565,7 +7687,9 @@ public function getChromeSignatureEnabledMetadata() /** * Sets chrome_signature_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $chrome_signature_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $chrome_signature_enabled_metadata chrome_signature_enabled_metadata + * * @return $this */ public function setChromeSignatureEnabledMetadata($chrome_signature_enabled_metadata) @@ -6577,6 +7701,7 @@ public function setChromeSignatureEnabledMetadata($chrome_signature_enabled_meta /** * Gets comment_email_show_message_text + * * @return string */ public function getCommentEmailShowMessageText() @@ -6586,7 +7711,9 @@ public function getCommentEmailShowMessageText() /** * Sets comment_email_show_message_text + * * @param string $comment_email_show_message_text + * * @return $this */ public function setCommentEmailShowMessageText($comment_email_show_message_text) @@ -6598,6 +7725,7 @@ public function setCommentEmailShowMessageText($comment_email_show_message_text) /** * Gets comment_email_show_message_text_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCommentEmailShowMessageTextMetadata() @@ -6607,7 +7735,9 @@ public function getCommentEmailShowMessageTextMetadata() /** * Sets comment_email_show_message_text_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $comment_email_show_message_text_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $comment_email_show_message_text_metadata comment_email_show_message_text_metadata + * * @return $this */ public function setCommentEmailShowMessageTextMetadata($comment_email_show_message_text_metadata) @@ -6619,6 +7749,7 @@ public function setCommentEmailShowMessageTextMetadata($comment_email_show_messa /** * Gets comments_allow_envelope_override + * * @return string */ public function getCommentsAllowEnvelopeOverride() @@ -6628,7 +7759,9 @@ public function getCommentsAllowEnvelopeOverride() /** * Sets comments_allow_envelope_override + * * @param string $comments_allow_envelope_override + * * @return $this */ public function setCommentsAllowEnvelopeOverride($comments_allow_envelope_override) @@ -6640,6 +7773,7 @@ public function setCommentsAllowEnvelopeOverride($comments_allow_envelope_overri /** * Gets comments_allow_envelope_override_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCommentsAllowEnvelopeOverrideMetadata() @@ -6649,7 +7783,9 @@ public function getCommentsAllowEnvelopeOverrideMetadata() /** * Sets comments_allow_envelope_override_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $comments_allow_envelope_override_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $comments_allow_envelope_override_metadata comments_allow_envelope_override_metadata + * * @return $this */ public function setCommentsAllowEnvelopeOverrideMetadata($comments_allow_envelope_override_metadata) @@ -6661,6 +7797,7 @@ public function setCommentsAllowEnvelopeOverrideMetadata($comments_allow_envelop /** * Gets conditional_fields_enabled + * * @return string */ public function getConditionalFieldsEnabled() @@ -6670,7 +7807,9 @@ public function getConditionalFieldsEnabled() /** * Sets conditional_fields_enabled + * * @param string $conditional_fields_enabled + * * @return $this */ public function setConditionalFieldsEnabled($conditional_fields_enabled) @@ -6682,6 +7821,7 @@ public function setConditionalFieldsEnabled($conditional_fields_enabled) /** * Gets conditional_fields_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getConditionalFieldsEnabledMetadata() @@ -6691,7 +7831,9 @@ public function getConditionalFieldsEnabledMetadata() /** * Sets conditional_fields_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $conditional_fields_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $conditional_fields_enabled_metadata conditional_fields_enabled_metadata + * * @return $this */ public function setConditionalFieldsEnabledMetadata($conditional_fields_enabled_metadata) @@ -6703,6 +7845,7 @@ public function setConditionalFieldsEnabledMetadata($conditional_fields_enabled_ /** * Gets consumer_disclosure_frequency + * * @return string */ public function getConsumerDisclosureFrequency() @@ -6712,7 +7855,9 @@ public function getConsumerDisclosureFrequency() /** * Sets consumer_disclosure_frequency + * * @param string $consumer_disclosure_frequency + * * @return $this */ public function setConsumerDisclosureFrequency($consumer_disclosure_frequency) @@ -6724,6 +7869,7 @@ public function setConsumerDisclosureFrequency($consumer_disclosure_frequency) /** * Gets consumer_disclosure_frequency_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getConsumerDisclosureFrequencyMetadata() @@ -6733,7 +7879,9 @@ public function getConsumerDisclosureFrequencyMetadata() /** * Sets consumer_disclosure_frequency_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $consumer_disclosure_frequency_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $consumer_disclosure_frequency_metadata consumer_disclosure_frequency_metadata + * * @return $this */ public function setConsumerDisclosureFrequencyMetadata($consumer_disclosure_frequency_metadata) @@ -6745,6 +7893,7 @@ public function setConsumerDisclosureFrequencyMetadata($consumer_disclosure_freq /** * Gets convert_pdf_fields + * * @return string */ public function getConvertPdfFields() @@ -6754,7 +7903,9 @@ public function getConvertPdfFields() /** * Sets convert_pdf_fields + * * @param string $convert_pdf_fields + * * @return $this */ public function setConvertPdfFields($convert_pdf_fields) @@ -6766,6 +7917,7 @@ public function setConvertPdfFields($convert_pdf_fields) /** * Gets convert_pdf_fields_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getConvertPdfFieldsMetadata() @@ -6775,7 +7927,9 @@ public function getConvertPdfFieldsMetadata() /** * Sets convert_pdf_fields_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $convert_pdf_fields_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $convert_pdf_fields_metadata convert_pdf_fields_metadata + * * @return $this */ public function setConvertPdfFieldsMetadata($convert_pdf_fields_metadata) @@ -6787,6 +7941,7 @@ public function setConvertPdfFieldsMetadata($convert_pdf_fields_metadata) /** * Gets data_population_scope + * * @return string */ public function getDataPopulationScope() @@ -6796,7 +7951,9 @@ public function getDataPopulationScope() /** * Sets data_population_scope + * * @param string $data_population_scope + * * @return $this */ public function setDataPopulationScope($data_population_scope) @@ -6808,6 +7965,7 @@ public function setDataPopulationScope($data_population_scope) /** * Gets data_population_scope_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDataPopulationScopeMetadata() @@ -6817,7 +7975,9 @@ public function getDataPopulationScopeMetadata() /** * Sets data_population_scope_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $data_population_scope_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $data_population_scope_metadata data_population_scope_metadata + * * @return $this */ public function setDataPopulationScopeMetadata($data_population_scope_metadata) @@ -6829,6 +7989,7 @@ public function setDataPopulationScopeMetadata($data_population_scope_metadata) /** * Gets disable_mobile_app + * * @return string */ public function getDisableMobileApp() @@ -6838,7 +7999,9 @@ public function getDisableMobileApp() /** * Sets disable_mobile_app + * * @param string $disable_mobile_app + * * @return $this */ public function setDisableMobileApp($disable_mobile_app) @@ -6850,6 +8013,7 @@ public function setDisableMobileApp($disable_mobile_app) /** * Gets disable_mobile_app_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableMobileAppMetadata() @@ -6859,7 +8023,9 @@ public function getDisableMobileAppMetadata() /** * Sets disable_mobile_app_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_mobile_app_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_mobile_app_metadata disable_mobile_app_metadata + * * @return $this */ public function setDisableMobileAppMetadata($disable_mobile_app_metadata) @@ -6871,6 +8037,7 @@ public function setDisableMobileAppMetadata($disable_mobile_app_metadata) /** * Gets disable_mobile_push_notifications + * * @return string */ public function getDisableMobilePushNotifications() @@ -6880,7 +8047,9 @@ public function getDisableMobilePushNotifications() /** * Sets disable_mobile_push_notifications + * * @param string $disable_mobile_push_notifications + * * @return $this */ public function setDisableMobilePushNotifications($disable_mobile_push_notifications) @@ -6892,6 +8061,7 @@ public function setDisableMobilePushNotifications($disable_mobile_push_notificat /** * Gets disable_mobile_push_notifications_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableMobilePushNotificationsMetadata() @@ -6901,7 +8071,9 @@ public function getDisableMobilePushNotificationsMetadata() /** * Sets disable_mobile_push_notifications_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_mobile_push_notifications_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_mobile_push_notifications_metadata disable_mobile_push_notifications_metadata + * * @return $this */ public function setDisableMobilePushNotificationsMetadata($disable_mobile_push_notifications_metadata) @@ -6913,6 +8085,7 @@ public function setDisableMobilePushNotificationsMetadata($disable_mobile_push_n /** * Gets disable_mobile_sending + * * @return string */ public function getDisableMobileSending() @@ -6922,7 +8095,9 @@ public function getDisableMobileSending() /** * Sets disable_mobile_sending + * * @param string $disable_mobile_sending + * * @return $this */ public function setDisableMobileSending($disable_mobile_sending) @@ -6934,6 +8109,7 @@ public function setDisableMobileSending($disable_mobile_sending) /** * Gets disable_mobile_sending_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableMobileSendingMetadata() @@ -6943,7 +8119,9 @@ public function getDisableMobileSendingMetadata() /** * Sets disable_mobile_sending_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_mobile_sending_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_mobile_sending_metadata disable_mobile_sending_metadata + * * @return $this */ public function setDisableMobileSendingMetadata($disable_mobile_sending_metadata) @@ -6955,6 +8133,7 @@ public function setDisableMobileSendingMetadata($disable_mobile_sending_metadata /** * Gets disable_multiple_sessions + * * @return string */ public function getDisableMultipleSessions() @@ -6964,7 +8143,9 @@ public function getDisableMultipleSessions() /** * Sets disable_multiple_sessions + * * @param string $disable_multiple_sessions + * * @return $this */ public function setDisableMultipleSessions($disable_multiple_sessions) @@ -6976,6 +8157,7 @@ public function setDisableMultipleSessions($disable_multiple_sessions) /** * Gets disable_multiple_sessions_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableMultipleSessionsMetadata() @@ -6985,7 +8167,9 @@ public function getDisableMultipleSessionsMetadata() /** * Sets disable_multiple_sessions_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_multiple_sessions_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_multiple_sessions_metadata disable_multiple_sessions_metadata + * * @return $this */ public function setDisableMultipleSessionsMetadata($disable_multiple_sessions_metadata) @@ -6997,6 +8181,7 @@ public function setDisableMultipleSessionsMetadata($disable_multiple_sessions_me /** * Gets disable_purge_notifications_for_sender_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisablePurgeNotificationsForSenderMetadata() @@ -7006,7 +8191,9 @@ public function getDisablePurgeNotificationsForSenderMetadata() /** * Sets disable_purge_notifications_for_sender_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_purge_notifications_for_sender_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_purge_notifications_for_sender_metadata disable_purge_notifications_for_sender_metadata + * * @return $this */ public function setDisablePurgeNotificationsForSenderMetadata($disable_purge_notifications_for_sender_metadata) @@ -7018,6 +8205,7 @@ public function setDisablePurgeNotificationsForSenderMetadata($disable_purge_not /** * Gets disable_signer_cert_view + * * @return string */ public function getDisableSignerCertView() @@ -7027,7 +8215,9 @@ public function getDisableSignerCertView() /** * Sets disable_signer_cert_view + * * @param string $disable_signer_cert_view + * * @return $this */ public function setDisableSignerCertView($disable_signer_cert_view) @@ -7039,6 +8229,7 @@ public function setDisableSignerCertView($disable_signer_cert_view) /** * Gets disable_signer_cert_view_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableSignerCertViewMetadata() @@ -7048,7 +8239,9 @@ public function getDisableSignerCertViewMetadata() /** * Sets disable_signer_cert_view_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_signer_cert_view_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_signer_cert_view_metadata disable_signer_cert_view_metadata + * * @return $this */ public function setDisableSignerCertViewMetadata($disable_signer_cert_view_metadata) @@ -7060,6 +8253,7 @@ public function setDisableSignerCertViewMetadata($disable_signer_cert_view_metad /** * Gets disable_signer_history_view + * * @return string */ public function getDisableSignerHistoryView() @@ -7069,7 +8263,9 @@ public function getDisableSignerHistoryView() /** * Sets disable_signer_history_view + * * @param string $disable_signer_history_view + * * @return $this */ public function setDisableSignerHistoryView($disable_signer_history_view) @@ -7081,6 +8277,7 @@ public function setDisableSignerHistoryView($disable_signer_history_view) /** * Gets disable_signer_history_view_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableSignerHistoryViewMetadata() @@ -7090,7 +8287,9 @@ public function getDisableSignerHistoryViewMetadata() /** * Sets disable_signer_history_view_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_signer_history_view_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_signer_history_view_metadata disable_signer_history_view_metadata + * * @return $this */ public function setDisableSignerHistoryViewMetadata($disable_signer_history_view_metadata) @@ -7102,6 +8301,7 @@ public function setDisableSignerHistoryViewMetadata($disable_signer_history_view /** * Gets disable_style_signature + * * @return string */ public function getDisableStyleSignature() @@ -7111,7 +8311,9 @@ public function getDisableStyleSignature() /** * Sets disable_style_signature + * * @param string $disable_style_signature + * * @return $this */ public function setDisableStyleSignature($disable_style_signature) @@ -7123,6 +8325,7 @@ public function setDisableStyleSignature($disable_style_signature) /** * Gets disable_style_signature_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableStyleSignatureMetadata() @@ -7132,7 +8335,9 @@ public function getDisableStyleSignatureMetadata() /** * Sets disable_style_signature_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_style_signature_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_style_signature_metadata disable_style_signature_metadata + * * @return $this */ public function setDisableStyleSignatureMetadata($disable_style_signature_metadata) @@ -7144,6 +8349,7 @@ public function setDisableStyleSignatureMetadata($disable_style_signature_metada /** * Gets disable_upload_signature + * * @return string */ public function getDisableUploadSignature() @@ -7153,7 +8359,9 @@ public function getDisableUploadSignature() /** * Sets disable_upload_signature + * * @param string $disable_upload_signature + * * @return $this */ public function setDisableUploadSignature($disable_upload_signature) @@ -7165,6 +8373,7 @@ public function setDisableUploadSignature($disable_upload_signature) /** * Gets disable_upload_signature_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableUploadSignatureMetadata() @@ -7174,7 +8383,9 @@ public function getDisableUploadSignatureMetadata() /** * Sets disable_upload_signature_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_upload_signature_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_upload_signature_metadata disable_upload_signature_metadata + * * @return $this */ public function setDisableUploadSignatureMetadata($disable_upload_signature_metadata) @@ -7186,6 +8397,7 @@ public function setDisableUploadSignatureMetadata($disable_upload_signature_meta /** * Gets disable_user_sharing + * * @return string */ public function getDisableUserSharing() @@ -7195,7 +8407,9 @@ public function getDisableUserSharing() /** * Sets disable_user_sharing + * * @param string $disable_user_sharing + * * @return $this */ public function setDisableUserSharing($disable_user_sharing) @@ -7207,6 +8421,7 @@ public function setDisableUserSharing($disable_user_sharing) /** * Gets disable_user_sharing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableUserSharingMetadata() @@ -7216,7 +8431,9 @@ public function getDisableUserSharingMetadata() /** * Sets disable_user_sharing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_user_sharing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_user_sharing_metadata disable_user_sharing_metadata + * * @return $this */ public function setDisableUserSharingMetadata($disable_user_sharing_metadata) @@ -7228,6 +8445,7 @@ public function setDisableUserSharingMetadata($disable_user_sharing_metadata) /** * Gets display_beta_switch + * * @return string */ public function getDisplayBetaSwitch() @@ -7237,7 +8455,9 @@ public function getDisplayBetaSwitch() /** * Sets display_beta_switch + * * @param string $display_beta_switch + * * @return $this */ public function setDisplayBetaSwitch($display_beta_switch) @@ -7249,6 +8469,7 @@ public function setDisplayBetaSwitch($display_beta_switch) /** * Gets display_beta_switch_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisplayBetaSwitchMetadata() @@ -7258,7 +8479,9 @@ public function getDisplayBetaSwitchMetadata() /** * Sets display_beta_switch_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $display_beta_switch_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $display_beta_switch_metadata display_beta_switch_metadata + * * @return $this */ public function setDisplayBetaSwitchMetadata($display_beta_switch_metadata) @@ -7270,6 +8493,7 @@ public function setDisplayBetaSwitchMetadata($display_beta_switch_metadata) /** * Gets document_conversion_restrictions + * * @return string */ public function getDocumentConversionRestrictions() @@ -7279,7 +8503,9 @@ public function getDocumentConversionRestrictions() /** * Sets document_conversion_restrictions + * * @param string $document_conversion_restrictions + * * @return $this */ public function setDocumentConversionRestrictions($document_conversion_restrictions) @@ -7291,6 +8517,7 @@ public function setDocumentConversionRestrictions($document_conversion_restricti /** * Gets document_conversion_restrictions_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDocumentConversionRestrictionsMetadata() @@ -7300,7 +8527,9 @@ public function getDocumentConversionRestrictionsMetadata() /** * Sets document_conversion_restrictions_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $document_conversion_restrictions_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $document_conversion_restrictions_metadata document_conversion_restrictions_metadata + * * @return $this */ public function setDocumentConversionRestrictionsMetadata($document_conversion_restrictions_metadata) @@ -7312,6 +8541,7 @@ public function setDocumentConversionRestrictionsMetadata($document_conversion_r /** * Gets document_retention + * * @return string */ public function getDocumentRetention() @@ -7321,7 +8551,9 @@ public function getDocumentRetention() /** * Sets document_retention + * * @param string $document_retention + * * @return $this */ public function setDocumentRetention($document_retention) @@ -7333,6 +8565,7 @@ public function setDocumentRetention($document_retention) /** * Gets document_retention_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDocumentRetentionMetadata() @@ -7342,7 +8575,9 @@ public function getDocumentRetentionMetadata() /** * Sets document_retention_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $document_retention_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $document_retention_metadata document_retention_metadata + * * @return $this */ public function setDocumentRetentionMetadata($document_retention_metadata) @@ -7354,6 +8589,7 @@ public function setDocumentRetentionMetadata($document_retention_metadata) /** * Gets document_retention_purge_tabs + * * @return string */ public function getDocumentRetentionPurgeTabs() @@ -7363,7 +8599,9 @@ public function getDocumentRetentionPurgeTabs() /** * Sets document_retention_purge_tabs + * * @param string $document_retention_purge_tabs + * * @return $this */ public function setDocumentRetentionPurgeTabs($document_retention_purge_tabs) @@ -7375,6 +8613,7 @@ public function setDocumentRetentionPurgeTabs($document_retention_purge_tabs) /** * Gets document_visibility + * * @return string */ public function getDocumentVisibility() @@ -7384,7 +8623,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param string $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -7396,6 +8637,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets document_visibility_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDocumentVisibilityMetadata() @@ -7405,7 +8647,9 @@ public function getDocumentVisibilityMetadata() /** * Sets document_visibility_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $document_visibility_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $document_visibility_metadata document_visibility_metadata + * * @return $this */ public function setDocumentVisibilityMetadata($document_visibility_metadata) @@ -7417,6 +8661,7 @@ public function setDocumentVisibilityMetadata($document_visibility_metadata) /** * Gets email_template_version + * * @return string */ public function getEmailTemplateVersion() @@ -7426,7 +8671,9 @@ public function getEmailTemplateVersion() /** * Sets email_template_version + * * @param string $email_template_version + * * @return $this */ public function setEmailTemplateVersion($email_template_version) @@ -7438,6 +8685,7 @@ public function setEmailTemplateVersion($email_template_version) /** * Gets email_template_version_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEmailTemplateVersionMetadata() @@ -7447,7 +8695,9 @@ public function getEmailTemplateVersionMetadata() /** * Sets email_template_version_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $email_template_version_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $email_template_version_metadata email_template_version_metadata + * * @return $this */ public function setEmailTemplateVersionMetadata($email_template_version_metadata) @@ -7459,6 +8709,7 @@ public function setEmailTemplateVersionMetadata($email_template_version_metadata /** * Gets enable_access_code_generator + * * @return string */ public function getEnableAccessCodeGenerator() @@ -7468,7 +8719,9 @@ public function getEnableAccessCodeGenerator() /** * Sets enable_access_code_generator + * * @param string $enable_access_code_generator + * * @return $this */ public function setEnableAccessCodeGenerator($enable_access_code_generator) @@ -7480,6 +8733,7 @@ public function setEnableAccessCodeGenerator($enable_access_code_generator) /** * Gets enable_access_code_generator_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableAccessCodeGeneratorMetadata() @@ -7489,7 +8743,9 @@ public function getEnableAccessCodeGeneratorMetadata() /** * Sets enable_access_code_generator_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_access_code_generator_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_access_code_generator_metadata enable_access_code_generator_metadata + * * @return $this */ public function setEnableAccessCodeGeneratorMetadata($enable_access_code_generator_metadata) @@ -7501,6 +8757,7 @@ public function setEnableAccessCodeGeneratorMetadata($enable_access_code_generat /** * Gets enable_advanced_payments + * * @return string */ public function getEnableAdvancedPayments() @@ -7510,7 +8767,9 @@ public function getEnableAdvancedPayments() /** * Sets enable_advanced_payments + * * @param string $enable_advanced_payments + * * @return $this */ public function setEnableAdvancedPayments($enable_advanced_payments) @@ -7522,6 +8781,7 @@ public function setEnableAdvancedPayments($enable_advanced_payments) /** * Gets enable_advanced_payments_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableAdvancedPaymentsMetadata() @@ -7531,7 +8791,9 @@ public function getEnableAdvancedPaymentsMetadata() /** * Sets enable_advanced_payments_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_advanced_payments_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_advanced_payments_metadata enable_advanced_payments_metadata + * * @return $this */ public function setEnableAdvancedPaymentsMetadata($enable_advanced_payments_metadata) @@ -7543,6 +8805,7 @@ public function setEnableAdvancedPaymentsMetadata($enable_advanced_payments_meta /** * Gets enable_advanced_power_forms + * * @return string */ public function getEnableAdvancedPowerForms() @@ -7552,7 +8815,9 @@ public function getEnableAdvancedPowerForms() /** * Sets enable_advanced_power_forms + * * @param string $enable_advanced_power_forms + * * @return $this */ public function setEnableAdvancedPowerForms($enable_advanced_power_forms) @@ -7564,6 +8829,7 @@ public function setEnableAdvancedPowerForms($enable_advanced_power_forms) /** * Gets enable_advanced_power_forms_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableAdvancedPowerFormsMetadata() @@ -7573,7 +8839,9 @@ public function getEnableAdvancedPowerFormsMetadata() /** * Sets enable_advanced_power_forms_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_advanced_power_forms_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_advanced_power_forms_metadata enable_advanced_power_forms_metadata + * * @return $this */ public function setEnableAdvancedPowerFormsMetadata($enable_advanced_power_forms_metadata) @@ -7585,6 +8853,7 @@ public function setEnableAdvancedPowerFormsMetadata($enable_advanced_power_forms /** * Gets enable_auto_nav + * * @return string */ public function getEnableAutoNav() @@ -7594,7 +8863,9 @@ public function getEnableAutoNav() /** * Sets enable_auto_nav + * * @param string $enable_auto_nav + * * @return $this */ public function setEnableAutoNav($enable_auto_nav) @@ -7606,6 +8877,7 @@ public function setEnableAutoNav($enable_auto_nav) /** * Gets enable_auto_nav_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableAutoNavMetadata() @@ -7615,7 +8887,9 @@ public function getEnableAutoNavMetadata() /** * Sets enable_auto_nav_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_auto_nav_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_auto_nav_metadata enable_auto_nav_metadata + * * @return $this */ public function setEnableAutoNavMetadata($enable_auto_nav_metadata) @@ -7627,6 +8901,7 @@ public function setEnableAutoNavMetadata($enable_auto_nav_metadata) /** * Gets enable_calculated_fields + * * @return string */ public function getEnableCalculatedFields() @@ -7636,7 +8911,9 @@ public function getEnableCalculatedFields() /** * Sets enable_calculated_fields + * * @param string $enable_calculated_fields + * * @return $this */ public function setEnableCalculatedFields($enable_calculated_fields) @@ -7648,6 +8925,7 @@ public function setEnableCalculatedFields($enable_calculated_fields) /** * Gets enable_calculated_fields_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableCalculatedFieldsMetadata() @@ -7657,7 +8935,9 @@ public function getEnableCalculatedFieldsMetadata() /** * Sets enable_calculated_fields_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_calculated_fields_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_calculated_fields_metadata enable_calculated_fields_metadata + * * @return $this */ public function setEnableCalculatedFieldsMetadata($enable_calculated_fields_metadata) @@ -7669,6 +8949,7 @@ public function setEnableCalculatedFieldsMetadata($enable_calculated_fields_meta /** * Gets enable_clickwraps + * * @return string */ public function getEnableClickwraps() @@ -7678,7 +8959,9 @@ public function getEnableClickwraps() /** * Sets enable_clickwraps + * * @param string $enable_clickwraps + * * @return $this */ public function setEnableClickwraps($enable_clickwraps) @@ -7690,6 +8973,7 @@ public function setEnableClickwraps($enable_clickwraps) /** * Gets enable_clickwraps_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableClickwrapsMetadata() @@ -7699,7 +8983,9 @@ public function getEnableClickwrapsMetadata() /** * Sets enable_clickwraps_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_clickwraps_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_clickwraps_metadata enable_clickwraps_metadata + * * @return $this */ public function setEnableClickwrapsMetadata($enable_clickwraps_metadata) @@ -7711,6 +8997,7 @@ public function setEnableClickwrapsMetadata($enable_clickwraps_metadata) /** * Gets enable_comments_history_download_in_signing + * * @return string */ public function getEnableCommentsHistoryDownloadInSigning() @@ -7720,7 +9007,9 @@ public function getEnableCommentsHistoryDownloadInSigning() /** * Sets enable_comments_history_download_in_signing + * * @param string $enable_comments_history_download_in_signing + * * @return $this */ public function setEnableCommentsHistoryDownloadInSigning($enable_comments_history_download_in_signing) @@ -7732,6 +9021,7 @@ public function setEnableCommentsHistoryDownloadInSigning($enable_comments_histo /** * Gets enable_comments_history_download_in_signing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableCommentsHistoryDownloadInSigningMetadata() @@ -7741,7 +9031,9 @@ public function getEnableCommentsHistoryDownloadInSigningMetadata() /** * Sets enable_comments_history_download_in_signing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_comments_history_download_in_signing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_comments_history_download_in_signing_metadata enable_comments_history_download_in_signing_metadata + * * @return $this */ public function setEnableCommentsHistoryDownloadInSigningMetadata($enable_comments_history_download_in_signing_metadata) @@ -7753,6 +9045,7 @@ public function setEnableCommentsHistoryDownloadInSigningMetadata($enable_commen /** * Gets enable_customer_satisfaction_metric_tracking + * * @return string */ public function getEnableCustomerSatisfactionMetricTracking() @@ -7762,7 +9055,9 @@ public function getEnableCustomerSatisfactionMetricTracking() /** * Sets enable_customer_satisfaction_metric_tracking + * * @param string $enable_customer_satisfaction_metric_tracking + * * @return $this */ public function setEnableCustomerSatisfactionMetricTracking($enable_customer_satisfaction_metric_tracking) @@ -7774,6 +9069,7 @@ public function setEnableCustomerSatisfactionMetricTracking($enable_customer_sat /** * Gets enable_customer_satisfaction_metric_tracking_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableCustomerSatisfactionMetricTrackingMetadata() @@ -7783,8 +9079,10 @@ public function getEnableCustomerSatisfactionMetricTrackingMetadata() /** * Sets enable_customer_satisfaction_metric_tracking_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_customer_satisfaction_metric_tracking_metadata - * @return $this + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_customer_satisfaction_metric_tracking_metadata enable_customer_satisfaction_metric_tracking_metadata + * + * @return $this */ public function setEnableCustomerSatisfactionMetricTrackingMetadata($enable_customer_satisfaction_metric_tracking_metadata) { @@ -7795,6 +9093,7 @@ public function setEnableCustomerSatisfactionMetricTrackingMetadata($enable_cust /** * Gets enable_ds_pro + * * @return string */ public function getEnableDsPro() @@ -7804,7 +9103,9 @@ public function getEnableDsPro() /** * Sets enable_ds_pro + * * @param string $enable_ds_pro + * * @return $this */ public function setEnableDsPro($enable_ds_pro) @@ -7816,6 +9117,7 @@ public function setEnableDsPro($enable_ds_pro) /** * Gets enable_ds_pro_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableDsProMetadata() @@ -7825,7 +9127,9 @@ public function getEnableDsProMetadata() /** * Sets enable_ds_pro_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_ds_pro_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_ds_pro_metadata enable_ds_pro_metadata + * * @return $this */ public function setEnableDsProMetadata($enable_ds_pro_metadata) @@ -7837,6 +9141,7 @@ public function setEnableDsProMetadata($enable_ds_pro_metadata) /** * Gets enable_envelope_stamping_by_account_admin + * * @return string */ public function getEnableEnvelopeStampingByAccountAdmin() @@ -7846,7 +9151,9 @@ public function getEnableEnvelopeStampingByAccountAdmin() /** * Sets enable_envelope_stamping_by_account_admin + * * @param string $enable_envelope_stamping_by_account_admin + * * @return $this */ public function setEnableEnvelopeStampingByAccountAdmin($enable_envelope_stamping_by_account_admin) @@ -7858,6 +9165,7 @@ public function setEnableEnvelopeStampingByAccountAdmin($enable_envelope_stampin /** * Gets enable_envelope_stamping_by_account_admin_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableEnvelopeStampingByAccountAdminMetadata() @@ -7867,7 +9175,9 @@ public function getEnableEnvelopeStampingByAccountAdminMetadata() /** * Sets enable_envelope_stamping_by_account_admin_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_envelope_stamping_by_account_admin_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_envelope_stamping_by_account_admin_metadata enable_envelope_stamping_by_account_admin_metadata + * * @return $this */ public function setEnableEnvelopeStampingByAccountAdminMetadata($enable_envelope_stamping_by_account_admin_metadata) @@ -7879,6 +9189,7 @@ public function setEnableEnvelopeStampingByAccountAdminMetadata($enable_envelope /** * Gets enable_envelope_stamping_by_ds_admin + * * @return string */ public function getEnableEnvelopeStampingByDsAdmin() @@ -7888,7 +9199,9 @@ public function getEnableEnvelopeStampingByDsAdmin() /** * Sets enable_envelope_stamping_by_ds_admin + * * @param string $enable_envelope_stamping_by_ds_admin + * * @return $this */ public function setEnableEnvelopeStampingByDsAdmin($enable_envelope_stamping_by_ds_admin) @@ -7900,6 +9213,7 @@ public function setEnableEnvelopeStampingByDsAdmin($enable_envelope_stamping_by_ /** * Gets enable_envelope_stamping_by_ds_admin_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableEnvelopeStampingByDsAdminMetadata() @@ -7909,7 +9223,9 @@ public function getEnableEnvelopeStampingByDsAdminMetadata() /** * Sets enable_envelope_stamping_by_ds_admin_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_envelope_stamping_by_ds_admin_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_envelope_stamping_by_ds_admin_metadata enable_envelope_stamping_by_ds_admin_metadata + * * @return $this */ public function setEnableEnvelopeStampingByDsAdminMetadata($enable_envelope_stamping_by_ds_admin_metadata) @@ -7921,6 +9237,7 @@ public function setEnableEnvelopeStampingByDsAdminMetadata($enable_envelope_stam /** * Gets enable_in_browser_editor + * * @return string */ public function getEnableInBrowserEditor() @@ -7930,7 +9247,9 @@ public function getEnableInBrowserEditor() /** * Sets enable_in_browser_editor + * * @param string $enable_in_browser_editor + * * @return $this */ public function setEnableInBrowserEditor($enable_in_browser_editor) @@ -7942,6 +9261,7 @@ public function setEnableInBrowserEditor($enable_in_browser_editor) /** * Gets enable_in_browser_editor_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableInBrowserEditorMetadata() @@ -7951,7 +9271,9 @@ public function getEnableInBrowserEditorMetadata() /** * Sets enable_in_browser_editor_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_in_browser_editor_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_in_browser_editor_metadata enable_in_browser_editor_metadata + * * @return $this */ public function setEnableInBrowserEditorMetadata($enable_in_browser_editor_metadata) @@ -7963,6 +9285,7 @@ public function setEnableInBrowserEditorMetadata($enable_in_browser_editor_metad /** * Gets enable_payment_processing + * * @return string */ public function getEnablePaymentProcessing() @@ -7972,7 +9295,9 @@ public function getEnablePaymentProcessing() /** * Sets enable_payment_processing + * * @param string $enable_payment_processing + * * @return $this */ public function setEnablePaymentProcessing($enable_payment_processing) @@ -7984,6 +9309,7 @@ public function setEnablePaymentProcessing($enable_payment_processing) /** * Gets enable_payment_processing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnablePaymentProcessingMetadata() @@ -7993,7 +9319,9 @@ public function getEnablePaymentProcessingMetadata() /** * Sets enable_payment_processing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_payment_processing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_payment_processing_metadata enable_payment_processing_metadata + * * @return $this */ public function setEnablePaymentProcessingMetadata($enable_payment_processing_metadata) @@ -8005,6 +9333,7 @@ public function setEnablePaymentProcessingMetadata($enable_payment_processing_me /** * Gets enable_power_form + * * @return string */ public function getEnablePowerForm() @@ -8014,7 +9343,9 @@ public function getEnablePowerForm() /** * Sets enable_power_form + * * @param string $enable_power_form + * * @return $this */ public function setEnablePowerForm($enable_power_form) @@ -8026,6 +9357,7 @@ public function setEnablePowerForm($enable_power_form) /** * Gets enable_power_form_direct + * * @return string */ public function getEnablePowerFormDirect() @@ -8035,7 +9367,9 @@ public function getEnablePowerFormDirect() /** * Sets enable_power_form_direct + * * @param string $enable_power_form_direct + * * @return $this */ public function setEnablePowerFormDirect($enable_power_form_direct) @@ -8047,6 +9381,7 @@ public function setEnablePowerFormDirect($enable_power_form_direct) /** * Gets enable_power_form_direct_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnablePowerFormDirectMetadata() @@ -8056,7 +9391,9 @@ public function getEnablePowerFormDirectMetadata() /** * Sets enable_power_form_direct_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_power_form_direct_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_power_form_direct_metadata enable_power_form_direct_metadata + * * @return $this */ public function setEnablePowerFormDirectMetadata($enable_power_form_direct_metadata) @@ -8068,6 +9405,7 @@ public function setEnablePowerFormDirectMetadata($enable_power_form_direct_metad /** * Gets enable_power_form_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnablePowerFormMetadata() @@ -8077,7 +9415,9 @@ public function getEnablePowerFormMetadata() /** * Sets enable_power_form_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_power_form_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_power_form_metadata enable_power_form_metadata + * * @return $this */ public function setEnablePowerFormMetadata($enable_power_form_metadata) @@ -8089,6 +9429,7 @@ public function setEnablePowerFormMetadata($enable_power_form_metadata) /** * Gets enable_recipient_domain_validation + * * @return string */ public function getEnableRecipientDomainValidation() @@ -8098,7 +9439,9 @@ public function getEnableRecipientDomainValidation() /** * Sets enable_recipient_domain_validation + * * @param string $enable_recipient_domain_validation + * * @return $this */ public function setEnableRecipientDomainValidation($enable_recipient_domain_validation) @@ -8110,6 +9453,7 @@ public function setEnableRecipientDomainValidation($enable_recipient_domain_vali /** * Gets enable_recipient_domain_validation_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableRecipientDomainValidationMetadata() @@ -8119,7 +9463,9 @@ public function getEnableRecipientDomainValidationMetadata() /** * Sets enable_recipient_domain_validation_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_recipient_domain_validation_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_recipient_domain_validation_metadata enable_recipient_domain_validation_metadata + * * @return $this */ public function setEnableRecipientDomainValidationMetadata($enable_recipient_domain_validation_metadata) @@ -8131,6 +9477,7 @@ public function setEnableRecipientDomainValidationMetadata($enable_recipient_dom /** * Gets enable_report_links + * * @return string */ public function getEnableReportLinks() @@ -8140,7 +9487,9 @@ public function getEnableReportLinks() /** * Sets enable_report_links + * * @param string $enable_report_links + * * @return $this */ public function setEnableReportLinks($enable_report_links) @@ -8152,6 +9501,7 @@ public function setEnableReportLinks($enable_report_links) /** * Gets enable_report_links_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableReportLinksMetadata() @@ -8161,7 +9511,9 @@ public function getEnableReportLinksMetadata() /** * Sets enable_report_links_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_report_links_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_report_links_metadata enable_report_links_metadata + * * @return $this */ public function setEnableReportLinksMetadata($enable_report_links_metadata) @@ -8173,6 +9525,7 @@ public function setEnableReportLinksMetadata($enable_report_links_metadata) /** * Gets enable_require_sign_on_paper + * * @return string */ public function getEnableRequireSignOnPaper() @@ -8182,7 +9535,9 @@ public function getEnableRequireSignOnPaper() /** * Sets enable_require_sign_on_paper + * * @param string $enable_require_sign_on_paper + * * @return $this */ public function setEnableRequireSignOnPaper($enable_require_sign_on_paper) @@ -8194,6 +9549,7 @@ public function setEnableRequireSignOnPaper($enable_require_sign_on_paper) /** * Gets enable_require_sign_on_paper_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableRequireSignOnPaperMetadata() @@ -8203,7 +9559,9 @@ public function getEnableRequireSignOnPaperMetadata() /** * Sets enable_require_sign_on_paper_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_require_sign_on_paper_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_require_sign_on_paper_metadata enable_require_sign_on_paper_metadata + * * @return $this */ public function setEnableRequireSignOnPaperMetadata($enable_require_sign_on_paper_metadata) @@ -8215,6 +9573,7 @@ public function setEnableRequireSignOnPaperMetadata($enable_require_sign_on_pape /** * Gets enable_reserved_domain + * * @return string */ public function getEnableReservedDomain() @@ -8224,7 +9583,9 @@ public function getEnableReservedDomain() /** * Sets enable_reserved_domain + * * @param string $enable_reserved_domain + * * @return $this */ public function setEnableReservedDomain($enable_reserved_domain) @@ -8236,6 +9597,7 @@ public function setEnableReservedDomain($enable_reserved_domain) /** * Gets enable_reserved_domain_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableReservedDomainMetadata() @@ -8245,7 +9607,9 @@ public function getEnableReservedDomainMetadata() /** * Sets enable_reserved_domain_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_reserved_domain_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_reserved_domain_metadata enable_reserved_domain_metadata + * * @return $this */ public function setEnableReservedDomainMetadata($enable_reserved_domain_metadata) @@ -8257,6 +9621,7 @@ public function setEnableReservedDomainMetadata($enable_reserved_domain_metadata /** * Gets enable_responsive_signing + * * @return string */ public function getEnableResponsiveSigning() @@ -8266,7 +9631,9 @@ public function getEnableResponsiveSigning() /** * Sets enable_responsive_signing + * * @param string $enable_responsive_signing + * * @return $this */ public function setEnableResponsiveSigning($enable_responsive_signing) @@ -8278,6 +9645,7 @@ public function setEnableResponsiveSigning($enable_responsive_signing) /** * Gets enable_responsive_signing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableResponsiveSigningMetadata() @@ -8287,7 +9655,9 @@ public function getEnableResponsiveSigningMetadata() /** * Sets enable_responsive_signing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_responsive_signing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_responsive_signing_metadata enable_responsive_signing_metadata + * * @return $this */ public function setEnableResponsiveSigningMetadata($enable_responsive_signing_metadata) @@ -8299,6 +9669,7 @@ public function setEnableResponsiveSigningMetadata($enable_responsive_signing_me /** * Gets enable_scheduled_release + * * @return string */ public function getEnableScheduledRelease() @@ -8308,7 +9679,9 @@ public function getEnableScheduledRelease() /** * Sets enable_scheduled_release + * * @param string $enable_scheduled_release + * * @return $this */ public function setEnableScheduledRelease($enable_scheduled_release) @@ -8320,6 +9693,7 @@ public function setEnableScheduledRelease($enable_scheduled_release) /** * Gets enable_scheduled_release_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableScheduledReleaseMetadata() @@ -8329,7 +9703,9 @@ public function getEnableScheduledReleaseMetadata() /** * Sets enable_scheduled_release_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_scheduled_release_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_scheduled_release_metadata enable_scheduled_release_metadata + * * @return $this */ public function setEnableScheduledReleaseMetadata($enable_scheduled_release_metadata) @@ -8341,6 +9717,7 @@ public function setEnableScheduledReleaseMetadata($enable_scheduled_release_meta /** * Gets enable_search_ui + * * @return string */ public function getEnableSearchUi() @@ -8350,7 +9727,9 @@ public function getEnableSearchUi() /** * Sets enable_search_ui + * * @param string $enable_search_ui + * * @return $this */ public function setEnableSearchUi($enable_search_ui) @@ -8362,6 +9741,7 @@ public function setEnableSearchUi($enable_search_ui) /** * Gets enable_search_ui_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSearchUiMetadata() @@ -8371,7 +9751,9 @@ public function getEnableSearchUiMetadata() /** * Sets enable_search_ui_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_search_ui_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_search_ui_metadata enable_search_ui_metadata + * * @return $this */ public function setEnableSearchUiMetadata($enable_search_ui_metadata) @@ -8383,6 +9765,7 @@ public function setEnableSearchUiMetadata($enable_search_ui_metadata) /** * Gets enable_sending_tags_font_settings + * * @return string */ public function getEnableSendingTagsFontSettings() @@ -8392,7 +9775,9 @@ public function getEnableSendingTagsFontSettings() /** * Sets enable_sending_tags_font_settings + * * @param string $enable_sending_tags_font_settings + * * @return $this */ public function setEnableSendingTagsFontSettings($enable_sending_tags_font_settings) @@ -8404,6 +9789,7 @@ public function setEnableSendingTagsFontSettings($enable_sending_tags_font_setti /** * Gets enable_sending_tags_font_settings_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSendingTagsFontSettingsMetadata() @@ -8413,7 +9799,9 @@ public function getEnableSendingTagsFontSettingsMetadata() /** * Sets enable_sending_tags_font_settings_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sending_tags_font_settings_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sending_tags_font_settings_metadata enable_sending_tags_font_settings_metadata + * * @return $this */ public function setEnableSendingTagsFontSettingsMetadata($enable_sending_tags_font_settings_metadata) @@ -8425,6 +9813,7 @@ public function setEnableSendingTagsFontSettingsMetadata($enable_sending_tags_fo /** * Gets enable_send_to_agent + * * @return string */ public function getEnableSendToAgent() @@ -8434,7 +9823,9 @@ public function getEnableSendToAgent() /** * Sets enable_send_to_agent + * * @param string $enable_send_to_agent + * * @return $this */ public function setEnableSendToAgent($enable_send_to_agent) @@ -8446,6 +9837,7 @@ public function setEnableSendToAgent($enable_send_to_agent) /** * Gets enable_send_to_agent_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSendToAgentMetadata() @@ -8455,7 +9847,9 @@ public function getEnableSendToAgentMetadata() /** * Sets enable_send_to_agent_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_send_to_agent_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_send_to_agent_metadata enable_send_to_agent_metadata + * * @return $this */ public function setEnableSendToAgentMetadata($enable_send_to_agent_metadata) @@ -8467,6 +9861,7 @@ public function setEnableSendToAgentMetadata($enable_send_to_agent_metadata) /** * Gets enable_send_to_intermediary + * * @return string */ public function getEnableSendToIntermediary() @@ -8476,7 +9871,9 @@ public function getEnableSendToIntermediary() /** * Sets enable_send_to_intermediary + * * @param string $enable_send_to_intermediary + * * @return $this */ public function setEnableSendToIntermediary($enable_send_to_intermediary) @@ -8488,6 +9885,7 @@ public function setEnableSendToIntermediary($enable_send_to_intermediary) /** * Gets enable_send_to_intermediary_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSendToIntermediaryMetadata() @@ -8497,7 +9895,9 @@ public function getEnableSendToIntermediaryMetadata() /** * Sets enable_send_to_intermediary_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_send_to_intermediary_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_send_to_intermediary_metadata enable_send_to_intermediary_metadata + * * @return $this */ public function setEnableSendToIntermediaryMetadata($enable_send_to_intermediary_metadata) @@ -8509,6 +9909,7 @@ public function setEnableSendToIntermediaryMetadata($enable_send_to_intermediary /** * Gets enable_send_to_manage + * * @return string */ public function getEnableSendToManage() @@ -8518,7 +9919,9 @@ public function getEnableSendToManage() /** * Sets enable_send_to_manage + * * @param string $enable_send_to_manage + * * @return $this */ public function setEnableSendToManage($enable_send_to_manage) @@ -8530,6 +9933,7 @@ public function setEnableSendToManage($enable_send_to_manage) /** * Gets enable_send_to_manage_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSendToManageMetadata() @@ -8539,7 +9943,9 @@ public function getEnableSendToManageMetadata() /** * Sets enable_send_to_manage_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_send_to_manage_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_send_to_manage_metadata enable_send_to_manage_metadata + * * @return $this */ public function setEnableSendToManageMetadata($enable_send_to_manage_metadata) @@ -8551,6 +9957,7 @@ public function setEnableSendToManageMetadata($enable_send_to_manage_metadata) /** * Gets enable_sequential_signing_api + * * @return string */ public function getEnableSequentialSigningApi() @@ -8560,7 +9967,9 @@ public function getEnableSequentialSigningApi() /** * Sets enable_sequential_signing_api + * * @param string $enable_sequential_signing_api + * * @return $this */ public function setEnableSequentialSigningApi($enable_sequential_signing_api) @@ -8572,6 +9981,7 @@ public function setEnableSequentialSigningApi($enable_sequential_signing_api) /** * Gets enable_sequential_signing_api_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSequentialSigningApiMetadata() @@ -8581,7 +9991,9 @@ public function getEnableSequentialSigningApiMetadata() /** * Sets enable_sequential_signing_api_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_api_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_api_metadata enable_sequential_signing_api_metadata + * * @return $this */ public function setEnableSequentialSigningApiMetadata($enable_sequential_signing_api_metadata) @@ -8593,6 +10005,7 @@ public function setEnableSequentialSigningApiMetadata($enable_sequential_signing /** * Gets enable_sequential_signing_ui + * * @return string */ public function getEnableSequentialSigningUi() @@ -8602,7 +10015,9 @@ public function getEnableSequentialSigningUi() /** * Sets enable_sequential_signing_ui + * * @param string $enable_sequential_signing_ui + * * @return $this */ public function setEnableSequentialSigningUi($enable_sequential_signing_ui) @@ -8614,6 +10029,7 @@ public function setEnableSequentialSigningUi($enable_sequential_signing_ui) /** * Gets enable_sequential_signing_ui_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSequentialSigningUiMetadata() @@ -8623,7 +10039,9 @@ public function getEnableSequentialSigningUiMetadata() /** * Sets enable_sequential_signing_ui_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_ui_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_ui_metadata enable_sequential_signing_ui_metadata + * * @return $this */ public function setEnableSequentialSigningUiMetadata($enable_sequential_signing_ui_metadata) @@ -8635,6 +10053,7 @@ public function setEnableSequentialSigningUiMetadata($enable_sequential_signing_ /** * Gets enable_signer_attachments + * * @return string */ public function getEnableSignerAttachments() @@ -8644,7 +10063,9 @@ public function getEnableSignerAttachments() /** * Sets enable_signer_attachments + * * @param string $enable_signer_attachments + * * @return $this */ public function setEnableSignerAttachments($enable_signer_attachments) @@ -8656,6 +10077,7 @@ public function setEnableSignerAttachments($enable_signer_attachments) /** * Gets enable_signer_attachments_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSignerAttachmentsMetadata() @@ -8665,7 +10087,9 @@ public function getEnableSignerAttachmentsMetadata() /** * Sets enable_signer_attachments_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signer_attachments_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signer_attachments_metadata enable_signer_attachments_metadata + * * @return $this */ public function setEnableSignerAttachmentsMetadata($enable_signer_attachments_metadata) @@ -8677,6 +10101,7 @@ public function setEnableSignerAttachmentsMetadata($enable_signer_attachments_me /** * Gets enable_signing_extension_comments + * * @return string */ public function getEnableSigningExtensionComments() @@ -8686,7 +10111,9 @@ public function getEnableSigningExtensionComments() /** * Sets enable_signing_extension_comments + * * @param string $enable_signing_extension_comments + * * @return $this */ public function setEnableSigningExtensionComments($enable_signing_extension_comments) @@ -8698,6 +10125,7 @@ public function setEnableSigningExtensionComments($enable_signing_extension_comm /** * Gets enable_signing_extension_comments_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSigningExtensionCommentsMetadata() @@ -8707,7 +10135,9 @@ public function getEnableSigningExtensionCommentsMetadata() /** * Sets enable_signing_extension_comments_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signing_extension_comments_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signing_extension_comments_metadata enable_signing_extension_comments_metadata + * * @return $this */ public function setEnableSigningExtensionCommentsMetadata($enable_signing_extension_comments_metadata) @@ -8719,6 +10149,7 @@ public function setEnableSigningExtensionCommentsMetadata($enable_signing_extens /** * Gets enable_signing_extension_conversations + * * @return string */ public function getEnableSigningExtensionConversations() @@ -8728,7 +10159,9 @@ public function getEnableSigningExtensionConversations() /** * Sets enable_signing_extension_conversations + * * @param string $enable_signing_extension_conversations + * * @return $this */ public function setEnableSigningExtensionConversations($enable_signing_extension_conversations) @@ -8740,6 +10173,7 @@ public function setEnableSigningExtensionConversations($enable_signing_extension /** * Gets enable_signing_extension_conversations_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSigningExtensionConversationsMetadata() @@ -8749,7 +10183,9 @@ public function getEnableSigningExtensionConversationsMetadata() /** * Sets enable_signing_extension_conversations_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signing_extension_conversations_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signing_extension_conversations_metadata enable_signing_extension_conversations_metadata + * * @return $this */ public function setEnableSigningExtensionConversationsMetadata($enable_signing_extension_conversations_metadata) @@ -8761,6 +10197,7 @@ public function setEnableSigningExtensionConversationsMetadata($enable_signing_e /** * Gets enable_signing_order_settings_for_account + * * @return string */ public function getEnableSigningOrderSettingsForAccount() @@ -8770,7 +10207,9 @@ public function getEnableSigningOrderSettingsForAccount() /** * Sets enable_signing_order_settings_for_account + * * @param string $enable_signing_order_settings_for_account + * * @return $this */ public function setEnableSigningOrderSettingsForAccount($enable_signing_order_settings_for_account) @@ -8782,6 +10221,7 @@ public function setEnableSigningOrderSettingsForAccount($enable_signing_order_se /** * Gets enable_signing_order_settings_for_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSigningOrderSettingsForAccountMetadata() @@ -8791,7 +10231,9 @@ public function getEnableSigningOrderSettingsForAccountMetadata() /** * Sets enable_signing_order_settings_for_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signing_order_settings_for_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signing_order_settings_for_account_metadata enable_signing_order_settings_for_account_metadata + * * @return $this */ public function setEnableSigningOrderSettingsForAccountMetadata($enable_signing_order_settings_for_account_metadata) @@ -8803,6 +10245,7 @@ public function setEnableSigningOrderSettingsForAccountMetadata($enable_signing_ /** * Gets enable_sign_on_paper + * * @return string */ public function getEnableSignOnPaper() @@ -8812,7 +10255,9 @@ public function getEnableSignOnPaper() /** * Sets enable_sign_on_paper + * * @param string $enable_sign_on_paper + * * @return $this */ public function setEnableSignOnPaper($enable_sign_on_paper) @@ -8824,6 +10269,7 @@ public function setEnableSignOnPaper($enable_sign_on_paper) /** * Gets enable_sign_on_paper_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSignOnPaperMetadata() @@ -8833,7 +10279,9 @@ public function getEnableSignOnPaperMetadata() /** * Sets enable_sign_on_paper_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sign_on_paper_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sign_on_paper_metadata enable_sign_on_paper_metadata + * * @return $this */ public function setEnableSignOnPaperMetadata($enable_sign_on_paper_metadata) @@ -8845,6 +10293,7 @@ public function setEnableSignOnPaperMetadata($enable_sign_on_paper_metadata) /** * Gets enable_sign_on_paper_override + * * @return string */ public function getEnableSignOnPaperOverride() @@ -8854,7 +10303,9 @@ public function getEnableSignOnPaperOverride() /** * Sets enable_sign_on_paper_override + * * @param string $enable_sign_on_paper_override + * * @return $this */ public function setEnableSignOnPaperOverride($enable_sign_on_paper_override) @@ -8866,6 +10317,7 @@ public function setEnableSignOnPaperOverride($enable_sign_on_paper_override) /** * Gets enable_sign_on_paper_override_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSignOnPaperOverrideMetadata() @@ -8875,7 +10327,9 @@ public function getEnableSignOnPaperOverrideMetadata() /** * Sets enable_sign_on_paper_override_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sign_on_paper_override_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sign_on_paper_override_metadata enable_sign_on_paper_override_metadata + * * @return $this */ public function setEnableSignOnPaperOverrideMetadata($enable_sign_on_paper_override_metadata) @@ -8887,6 +10341,7 @@ public function setEnableSignOnPaperOverrideMetadata($enable_sign_on_paper_overr /** * Gets enable_sign_with_notary + * * @return string */ public function getEnableSignWithNotary() @@ -8896,7 +10351,9 @@ public function getEnableSignWithNotary() /** * Sets enable_sign_with_notary + * * @param string $enable_sign_with_notary + * * @return $this */ public function setEnableSignWithNotary($enable_sign_with_notary) @@ -8908,6 +10365,7 @@ public function setEnableSignWithNotary($enable_sign_with_notary) /** * Gets enable_sign_with_notary_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSignWithNotaryMetadata() @@ -8917,7 +10375,9 @@ public function getEnableSignWithNotaryMetadata() /** * Sets enable_sign_with_notary_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sign_with_notary_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sign_with_notary_metadata enable_sign_with_notary_metadata + * * @return $this */ public function setEnableSignWithNotaryMetadata($enable_sign_with_notary_metadata) @@ -8929,6 +10389,7 @@ public function setEnableSignWithNotaryMetadata($enable_sign_with_notary_metadat /** * Gets enable_smart_contracts + * * @return string */ public function getEnableSmartContracts() @@ -8938,7 +10399,9 @@ public function getEnableSmartContracts() /** * Sets enable_smart_contracts + * * @param string $enable_smart_contracts + * * @return $this */ public function setEnableSmartContracts($enable_smart_contracts) @@ -8950,6 +10413,7 @@ public function setEnableSmartContracts($enable_smart_contracts) /** * Gets enable_smart_contracts_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSmartContractsMetadata() @@ -8959,7 +10423,9 @@ public function getEnableSmartContractsMetadata() /** * Sets enable_smart_contracts_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_smart_contracts_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_smart_contracts_metadata enable_smart_contracts_metadata + * * @return $this */ public function setEnableSmartContractsMetadata($enable_smart_contracts_metadata) @@ -8971,6 +10437,7 @@ public function setEnableSmartContractsMetadata($enable_smart_contracts_metadata /** * Gets enable_sms_authentication + * * @return string */ public function getEnableSmsAuthentication() @@ -8980,7 +10447,9 @@ public function getEnableSmsAuthentication() /** * Sets enable_sms_authentication + * * @param string $enable_sms_authentication + * * @return $this */ public function setEnableSmsAuthentication($enable_sms_authentication) @@ -8992,6 +10461,7 @@ public function setEnableSmsAuthentication($enable_sms_authentication) /** * Gets enable_sms_authentication_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSmsAuthenticationMetadata() @@ -9001,7 +10471,9 @@ public function getEnableSmsAuthenticationMetadata() /** * Sets enable_sms_authentication_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sms_authentication_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sms_authentication_metadata enable_sms_authentication_metadata + * * @return $this */ public function setEnableSmsAuthenticationMetadata($enable_sms_authentication_metadata) @@ -9013,6 +10485,7 @@ public function setEnableSmsAuthenticationMetadata($enable_sms_authentication_me /** * Gets enable_social_id_login + * * @return string */ public function getEnableSocialIdLogin() @@ -9022,7 +10495,9 @@ public function getEnableSocialIdLogin() /** * Sets enable_social_id_login + * * @param string $enable_social_id_login + * * @return $this */ public function setEnableSocialIdLogin($enable_social_id_login) @@ -9034,6 +10509,7 @@ public function setEnableSocialIdLogin($enable_social_id_login) /** * Gets enable_social_id_login_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSocialIdLoginMetadata() @@ -9043,7 +10519,9 @@ public function getEnableSocialIdLoginMetadata() /** * Sets enable_social_id_login_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_social_id_login_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_social_id_login_metadata enable_social_id_login_metadata + * * @return $this */ public function setEnableSocialIdLoginMetadata($enable_social_id_login_metadata) @@ -9055,6 +10533,7 @@ public function setEnableSocialIdLoginMetadata($enable_social_id_login_metadata) /** * Gets enable_strike_through + * * @return string */ public function getEnableStrikeThrough() @@ -9064,7 +10543,9 @@ public function getEnableStrikeThrough() /** * Sets enable_strike_through + * * @param string $enable_strike_through + * * @return $this */ public function setEnableStrikeThrough($enable_strike_through) @@ -9076,6 +10557,7 @@ public function setEnableStrikeThrough($enable_strike_through) /** * Gets enable_strike_through_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableStrikeThroughMetadata() @@ -9085,7 +10567,9 @@ public function getEnableStrikeThroughMetadata() /** * Sets enable_strike_through_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_strike_through_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_strike_through_metadata enable_strike_through_metadata + * * @return $this */ public function setEnableStrikeThroughMetadata($enable_strike_through_metadata) @@ -9097,6 +10581,7 @@ public function setEnableStrikeThroughMetadata($enable_strike_through_metadata) /** * Gets enable_transaction_point + * * @return string */ public function getEnableTransactionPoint() @@ -9106,7 +10591,9 @@ public function getEnableTransactionPoint() /** * Sets enable_transaction_point + * * @param string $enable_transaction_point + * * @return $this */ public function setEnableTransactionPoint($enable_transaction_point) @@ -9118,6 +10605,7 @@ public function setEnableTransactionPoint($enable_transaction_point) /** * Gets enable_transaction_point_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableTransactionPointMetadata() @@ -9127,7 +10615,9 @@ public function getEnableTransactionPointMetadata() /** * Sets enable_transaction_point_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_transaction_point_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_transaction_point_metadata enable_transaction_point_metadata + * * @return $this */ public function setEnableTransactionPointMetadata($enable_transaction_point_metadata) @@ -9139,6 +10629,7 @@ public function setEnableTransactionPointMetadata($enable_transaction_point_meta /** * Gets enable_vaulting + * * @return string */ public function getEnableVaulting() @@ -9148,7 +10639,9 @@ public function getEnableVaulting() /** * Sets enable_vaulting + * * @param string $enable_vaulting + * * @return $this */ public function setEnableVaulting($enable_vaulting) @@ -9160,6 +10653,7 @@ public function setEnableVaulting($enable_vaulting) /** * Gets enable_vaulting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableVaultingMetadata() @@ -9169,7 +10663,9 @@ public function getEnableVaultingMetadata() /** * Sets enable_vaulting_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_vaulting_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_vaulting_metadata enable_vaulting_metadata + * * @return $this */ public function setEnableVaultingMetadata($enable_vaulting_metadata) @@ -9181,6 +10677,7 @@ public function setEnableVaultingMetadata($enable_vaulting_metadata) /** * Gets enable_witnessing + * * @return string */ public function getEnableWitnessing() @@ -9190,7 +10687,9 @@ public function getEnableWitnessing() /** * Sets enable_witnessing + * * @param string $enable_witnessing + * * @return $this */ public function setEnableWitnessing($enable_witnessing) @@ -9202,6 +10701,7 @@ public function setEnableWitnessing($enable_witnessing) /** * Gets enable_witnessing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableWitnessingMetadata() @@ -9211,7 +10711,9 @@ public function getEnableWitnessingMetadata() /** * Sets enable_witnessing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_witnessing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_witnessing_metadata enable_witnessing_metadata + * * @return $this */ public function setEnableWitnessingMetadata($enable_witnessing_metadata) @@ -9223,6 +10725,7 @@ public function setEnableWitnessingMetadata($enable_witnessing_metadata) /** * Gets enforce_template_name_uniqueness + * * @return string */ public function getEnforceTemplateNameUniqueness() @@ -9232,7 +10735,9 @@ public function getEnforceTemplateNameUniqueness() /** * Sets enforce_template_name_uniqueness + * * @param string $enforce_template_name_uniqueness + * * @return $this */ public function setEnforceTemplateNameUniqueness($enforce_template_name_uniqueness) @@ -9244,6 +10749,7 @@ public function setEnforceTemplateNameUniqueness($enforce_template_name_uniquene /** * Gets enforce_template_name_uniqueness_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnforceTemplateNameUniquenessMetadata() @@ -9253,7 +10759,9 @@ public function getEnforceTemplateNameUniquenessMetadata() /** * Sets enforce_template_name_uniqueness_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enforce_template_name_uniqueness_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enforce_template_name_uniqueness_metadata enforce_template_name_uniqueness_metadata + * * @return $this */ public function setEnforceTemplateNameUniquenessMetadata($enforce_template_name_uniqueness_metadata) @@ -9265,6 +10773,7 @@ public function setEnforceTemplateNameUniquenessMetadata($enforce_template_name_ /** * Gets envelope_integration_allowed + * * @return string */ public function getEnvelopeIntegrationAllowed() @@ -9274,7 +10783,9 @@ public function getEnvelopeIntegrationAllowed() /** * Sets envelope_integration_allowed + * * @param string $envelope_integration_allowed + * * @return $this */ public function setEnvelopeIntegrationAllowed($envelope_integration_allowed) @@ -9286,6 +10797,7 @@ public function setEnvelopeIntegrationAllowed($envelope_integration_allowed) /** * Gets envelope_integration_allowed_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnvelopeIntegrationAllowedMetadata() @@ -9295,7 +10807,9 @@ public function getEnvelopeIntegrationAllowedMetadata() /** * Sets envelope_integration_allowed_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $envelope_integration_allowed_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $envelope_integration_allowed_metadata envelope_integration_allowed_metadata + * * @return $this */ public function setEnvelopeIntegrationAllowedMetadata($envelope_integration_allowed_metadata) @@ -9307,6 +10821,7 @@ public function setEnvelopeIntegrationAllowedMetadata($envelope_integration_allo /** * Gets envelope_integration_enabled + * * @return string */ public function getEnvelopeIntegrationEnabled() @@ -9316,7 +10831,9 @@ public function getEnvelopeIntegrationEnabled() /** * Sets envelope_integration_enabled + * * @param string $envelope_integration_enabled + * * @return $this */ public function setEnvelopeIntegrationEnabled($envelope_integration_enabled) @@ -9328,6 +10845,7 @@ public function setEnvelopeIntegrationEnabled($envelope_integration_enabled) /** * Gets envelope_integration_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnvelopeIntegrationEnabledMetadata() @@ -9337,7 +10855,9 @@ public function getEnvelopeIntegrationEnabledMetadata() /** * Sets envelope_integration_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $envelope_integration_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $envelope_integration_enabled_metadata envelope_integration_enabled_metadata + * * @return $this */ public function setEnvelopeIntegrationEnabledMetadata($envelope_integration_enabled_metadata) @@ -9349,6 +10869,7 @@ public function setEnvelopeIntegrationEnabledMetadata($envelope_integration_enab /** * Gets envelope_stamping_default_value + * * @return string */ public function getEnvelopeStampingDefaultValue() @@ -9358,7 +10879,9 @@ public function getEnvelopeStampingDefaultValue() /** * Sets envelope_stamping_default_value + * * @param string $envelope_stamping_default_value + * * @return $this */ public function setEnvelopeStampingDefaultValue($envelope_stamping_default_value) @@ -9370,6 +10893,7 @@ public function setEnvelopeStampingDefaultValue($envelope_stamping_default_value /** * Gets envelope_stamping_default_value_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnvelopeStampingDefaultValueMetadata() @@ -9379,7 +10903,9 @@ public function getEnvelopeStampingDefaultValueMetadata() /** * Sets envelope_stamping_default_value_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $envelope_stamping_default_value_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $envelope_stamping_default_value_metadata envelope_stamping_default_value_metadata + * * @return $this */ public function setEnvelopeStampingDefaultValueMetadata($envelope_stamping_default_value_metadata) @@ -9391,6 +10917,7 @@ public function setEnvelopeStampingDefaultValueMetadata($envelope_stamping_defau /** * Gets express_send + * * @return string */ public function getExpressSend() @@ -9400,7 +10927,9 @@ public function getExpressSend() /** * Sets express_send + * * @param string $express_send + * * @return $this */ public function setExpressSend($express_send) @@ -9412,6 +10941,7 @@ public function setExpressSend($express_send) /** * Gets express_send_allow_tabs + * * @return string */ public function getExpressSendAllowTabs() @@ -9421,7 +10951,9 @@ public function getExpressSendAllowTabs() /** * Sets express_send_allow_tabs + * * @param string $express_send_allow_tabs + * * @return $this */ public function setExpressSendAllowTabs($express_send_allow_tabs) @@ -9433,6 +10965,7 @@ public function setExpressSendAllowTabs($express_send_allow_tabs) /** * Gets express_send_allow_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getExpressSendAllowTabsMetadata() @@ -9442,7 +10975,9 @@ public function getExpressSendAllowTabsMetadata() /** * Sets express_send_allow_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $express_send_allow_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $express_send_allow_tabs_metadata express_send_allow_tabs_metadata + * * @return $this */ public function setExpressSendAllowTabsMetadata($express_send_allow_tabs_metadata) @@ -9454,6 +10989,7 @@ public function setExpressSendAllowTabsMetadata($express_send_allow_tabs_metadat /** * Gets express_send_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getExpressSendMetadata() @@ -9463,7 +10999,9 @@ public function getExpressSendMetadata() /** * Sets express_send_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $express_send_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $express_send_metadata express_send_metadata + * * @return $this */ public function setExpressSendMetadata($express_send_metadata) @@ -9475,6 +11013,7 @@ public function setExpressSendMetadata($express_send_metadata) /** * Gets external_document_sources + * * @return \DocuSign\eSign\Model\ExternalDocumentSources */ public function getExternalDocumentSources() @@ -9484,7 +11023,9 @@ public function getExternalDocumentSources() /** * Sets external_document_sources - * @param \DocuSign\eSign\Model\ExternalDocumentSources $external_document_sources + * + * @param \DocuSign\eSign\Model\ExternalDocumentSources $external_document_sources external_document_sources + * * @return $this */ public function setExternalDocumentSources($external_document_sources) @@ -9496,6 +11037,7 @@ public function setExternalDocumentSources($external_document_sources) /** * Gets external_signature_pad_type + * * @return string */ public function getExternalSignaturePadType() @@ -9505,7 +11047,9 @@ public function getExternalSignaturePadType() /** * Sets external_signature_pad_type + * * @param string $external_signature_pad_type + * * @return $this */ public function setExternalSignaturePadType($external_signature_pad_type) @@ -9517,6 +11061,7 @@ public function setExternalSignaturePadType($external_signature_pad_type) /** * Gets external_signature_pad_type_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getExternalSignaturePadTypeMetadata() @@ -9526,7 +11071,9 @@ public function getExternalSignaturePadTypeMetadata() /** * Sets external_signature_pad_type_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $external_signature_pad_type_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $external_signature_pad_type_metadata external_signature_pad_type_metadata + * * @return $this */ public function setExternalSignaturePadTypeMetadata($external_signature_pad_type_metadata) @@ -9538,6 +11085,7 @@ public function setExternalSignaturePadTypeMetadata($external_signature_pad_type /** * Gets fax_out_enabled + * * @return string */ public function getFaxOutEnabled() @@ -9547,7 +11095,9 @@ public function getFaxOutEnabled() /** * Sets fax_out_enabled + * * @param string $fax_out_enabled + * * @return $this */ public function setFaxOutEnabled($fax_out_enabled) @@ -9559,6 +11109,7 @@ public function setFaxOutEnabled($fax_out_enabled) /** * Gets fax_out_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getFaxOutEnabledMetadata() @@ -9568,7 +11119,9 @@ public function getFaxOutEnabledMetadata() /** * Sets fax_out_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $fax_out_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $fax_out_enabled_metadata fax_out_enabled_metadata + * * @return $this */ public function setFaxOutEnabledMetadata($fax_out_enabled_metadata) @@ -9580,6 +11133,7 @@ public function setFaxOutEnabledMetadata($fax_out_enabled_metadata) /** * Gets guided_forms_html_allowed + * * @return string */ public function getGuidedFormsHtmlAllowed() @@ -9589,7 +11143,9 @@ public function getGuidedFormsHtmlAllowed() /** * Sets guided_forms_html_allowed + * * @param string $guided_forms_html_allowed + * * @return $this */ public function setGuidedFormsHtmlAllowed($guided_forms_html_allowed) @@ -9601,6 +11157,7 @@ public function setGuidedFormsHtmlAllowed($guided_forms_html_allowed) /** * Gets guided_forms_html_allowed_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getGuidedFormsHtmlAllowedMetadata() @@ -9610,7 +11167,9 @@ public function getGuidedFormsHtmlAllowedMetadata() /** * Sets guided_forms_html_allowed_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $guided_forms_html_allowed_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $guided_forms_html_allowed_metadata guided_forms_html_allowed_metadata + * * @return $this */ public function setGuidedFormsHtmlAllowedMetadata($guided_forms_html_allowed_metadata) @@ -9622,6 +11181,7 @@ public function setGuidedFormsHtmlAllowedMetadata($guided_forms_html_allowed_met /** * Gets hide_account_address_in_co_c + * * @return string */ public function getHideAccountAddressInCoC() @@ -9631,7 +11191,9 @@ public function getHideAccountAddressInCoC() /** * Sets hide_account_address_in_co_c + * * @param string $hide_account_address_in_co_c + * * @return $this */ public function setHideAccountAddressInCoC($hide_account_address_in_co_c) @@ -9643,6 +11205,7 @@ public function setHideAccountAddressInCoC($hide_account_address_in_co_c) /** * Gets hide_account_address_in_co_c_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getHideAccountAddressInCoCMetadata() @@ -9652,7 +11215,9 @@ public function getHideAccountAddressInCoCMetadata() /** * Sets hide_account_address_in_co_c_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $hide_account_address_in_co_c_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $hide_account_address_in_co_c_metadata hide_account_address_in_co_c_metadata + * * @return $this */ public function setHideAccountAddressInCoCMetadata($hide_account_address_in_co_c_metadata) @@ -9664,6 +11229,7 @@ public function setHideAccountAddressInCoCMetadata($hide_account_address_in_co_c /** * Gets hide_pricing + * * @return string */ public function getHidePricing() @@ -9673,7 +11239,9 @@ public function getHidePricing() /** * Sets hide_pricing + * * @param string $hide_pricing + * * @return $this */ public function setHidePricing($hide_pricing) @@ -9685,6 +11253,7 @@ public function setHidePricing($hide_pricing) /** * Gets hide_pricing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getHidePricingMetadata() @@ -9694,7 +11263,9 @@ public function getHidePricingMetadata() /** * Sets hide_pricing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $hide_pricing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $hide_pricing_metadata hide_pricing_metadata + * * @return $this */ public function setHidePricingMetadata($hide_pricing_metadata) @@ -9706,6 +11277,7 @@ public function setHidePricingMetadata($hide_pricing_metadata) /** * Gets id_check_configurations + * * @return \DocuSign\eSign\Model\IdCheckConfiguration[] */ public function getIdCheckConfigurations() @@ -9715,7 +11287,9 @@ public function getIdCheckConfigurations() /** * Sets id_check_configurations + * * @param \DocuSign\eSign\Model\IdCheckConfiguration[] $id_check_configurations + * * @return $this */ public function setIdCheckConfigurations($id_check_configurations) @@ -9727,6 +11301,7 @@ public function setIdCheckConfigurations($id_check_configurations) /** * Gets id_check_expire + * * @return string */ public function getIdCheckExpire() @@ -9736,7 +11311,9 @@ public function getIdCheckExpire() /** * Sets id_check_expire + * * @param string $id_check_expire + * * @return $this */ public function setIdCheckExpire($id_check_expire) @@ -9748,6 +11325,7 @@ public function setIdCheckExpire($id_check_expire) /** * Gets id_check_expire_days + * * @return string */ public function getIdCheckExpireDays() @@ -9757,7 +11335,9 @@ public function getIdCheckExpireDays() /** * Sets id_check_expire_days + * * @param string $id_check_expire_days + * * @return $this */ public function setIdCheckExpireDays($id_check_expire_days) @@ -9769,6 +11349,7 @@ public function setIdCheckExpireDays($id_check_expire_days) /** * Gets id_check_expire_days_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getIdCheckExpireDaysMetadata() @@ -9778,7 +11359,9 @@ public function getIdCheckExpireDaysMetadata() /** * Sets id_check_expire_days_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $id_check_expire_days_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $id_check_expire_days_metadata id_check_expire_days_metadata + * * @return $this */ public function setIdCheckExpireDaysMetadata($id_check_expire_days_metadata) @@ -9790,6 +11373,7 @@ public function setIdCheckExpireDaysMetadata($id_check_expire_days_metadata) /** * Gets id_check_expire_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getIdCheckExpireMetadata() @@ -9799,7 +11383,9 @@ public function getIdCheckExpireMetadata() /** * Sets id_check_expire_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $id_check_expire_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $id_check_expire_metadata id_check_expire_metadata + * * @return $this */ public function setIdCheckExpireMetadata($id_check_expire_metadata) @@ -9811,6 +11397,7 @@ public function setIdCheckExpireMetadata($id_check_expire_metadata) /** * Gets id_check_expire_minutes + * * @return string */ public function getIdCheckExpireMinutes() @@ -9820,7 +11407,9 @@ public function getIdCheckExpireMinutes() /** * Sets id_check_expire_minutes + * * @param string $id_check_expire_minutes + * * @return $this */ public function setIdCheckExpireMinutes($id_check_expire_minutes) @@ -9832,6 +11421,7 @@ public function setIdCheckExpireMinutes($id_check_expire_minutes) /** * Gets id_check_expire_minutes_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getIdCheckExpireMinutesMetadata() @@ -9841,7 +11431,9 @@ public function getIdCheckExpireMinutesMetadata() /** * Sets id_check_expire_minutes_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $id_check_expire_minutes_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $id_check_expire_minutes_metadata id_check_expire_minutes_metadata + * * @return $this */ public function setIdCheckExpireMinutesMetadata($id_check_expire_minutes_metadata) @@ -9853,6 +11445,7 @@ public function setIdCheckExpireMinutesMetadata($id_check_expire_minutes_metadat /** * Gets id_check_required + * * @return string */ public function getIdCheckRequired() @@ -9862,7 +11455,9 @@ public function getIdCheckRequired() /** * Sets id_check_required + * * @param string $id_check_required + * * @return $this */ public function setIdCheckRequired($id_check_required) @@ -9874,6 +11469,7 @@ public function setIdCheckRequired($id_check_required) /** * Gets id_check_required_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getIdCheckRequiredMetadata() @@ -9883,7 +11479,9 @@ public function getIdCheckRequiredMetadata() /** * Sets id_check_required_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $id_check_required_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $id_check_required_metadata id_check_required_metadata + * * @return $this */ public function setIdCheckRequiredMetadata($id_check_required_metadata) @@ -9895,6 +11493,7 @@ public function setIdCheckRequiredMetadata($id_check_required_metadata) /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\AccountIdentityVerificationWorkflow[] */ public function getIdentityVerification() @@ -9904,7 +11503,9 @@ public function getIdentityVerification() /** * Sets identity_verification + * * @param \DocuSign\eSign\Model\AccountIdentityVerificationWorkflow[] $identity_verification + * * @return $this */ public function setIdentityVerification($identity_verification) @@ -9916,6 +11517,7 @@ public function setIdentityVerification($identity_verification) /** * Gets identity_verification_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getIdentityVerificationMetadata() @@ -9925,7 +11527,9 @@ public function getIdentityVerificationMetadata() /** * Sets identity_verification_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $identity_verification_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $identity_verification_metadata identity_verification_metadata + * * @return $this */ public function setIdentityVerificationMetadata($identity_verification_metadata) @@ -9937,6 +11541,7 @@ public function setIdentityVerificationMetadata($identity_verification_metadata) /** * Gets ignore_error_if_anchor_tab_not_found + * * @return string */ public function getIgnoreErrorIfAnchorTabNotFound() @@ -9946,7 +11551,9 @@ public function getIgnoreErrorIfAnchorTabNotFound() /** * Sets ignore_error_if_anchor_tab_not_found + * * @param string $ignore_error_if_anchor_tab_not_found + * * @return $this */ public function setIgnoreErrorIfAnchorTabNotFound($ignore_error_if_anchor_tab_not_found) @@ -9958,6 +11565,7 @@ public function setIgnoreErrorIfAnchorTabNotFound($ignore_error_if_anchor_tab_no /** * Gets ignore_error_if_anchor_tab_not_found_metadata_enabled + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getIgnoreErrorIfAnchorTabNotFoundMetadataEnabled() @@ -9967,7 +11575,9 @@ public function getIgnoreErrorIfAnchorTabNotFoundMetadataEnabled() /** * Sets ignore_error_if_anchor_tab_not_found_metadata_enabled - * @param \DocuSign\eSign\Model\SettingsMetadata $ignore_error_if_anchor_tab_not_found_metadata_enabled + * + * @param \DocuSign\eSign\Model\SettingsMetadata $ignore_error_if_anchor_tab_not_found_metadata_enabled ignore_error_if_anchor_tab_not_found_metadata_enabled + * * @return $this */ public function setIgnoreErrorIfAnchorTabNotFoundMetadataEnabled($ignore_error_if_anchor_tab_not_found_metadata_enabled) @@ -9979,6 +11589,7 @@ public function setIgnoreErrorIfAnchorTabNotFoundMetadataEnabled($ignore_error_i /** * Gets in_person_id_check_question + * * @return string */ public function getInPersonIdCheckQuestion() @@ -9988,7 +11599,9 @@ public function getInPersonIdCheckQuestion() /** * Sets in_person_id_check_question + * * @param string $in_person_id_check_question + * * @return $this */ public function setInPersonIdCheckQuestion($in_person_id_check_question) @@ -10000,6 +11613,7 @@ public function setInPersonIdCheckQuestion($in_person_id_check_question) /** * Gets in_person_id_check_question_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getInPersonIdCheckQuestionMetadata() @@ -10009,7 +11623,9 @@ public function getInPersonIdCheckQuestionMetadata() /** * Sets in_person_id_check_question_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $in_person_id_check_question_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $in_person_id_check_question_metadata in_person_id_check_question_metadata + * * @return $this */ public function setInPersonIdCheckQuestionMetadata($in_person_id_check_question_metadata) @@ -10021,6 +11637,7 @@ public function setInPersonIdCheckQuestionMetadata($in_person_id_check_question_ /** * Gets in_person_signing_enabled + * * @return string */ public function getInPersonSigningEnabled() @@ -10030,7 +11647,9 @@ public function getInPersonSigningEnabled() /** * Sets in_person_signing_enabled + * * @param string $in_person_signing_enabled + * * @return $this */ public function setInPersonSigningEnabled($in_person_signing_enabled) @@ -10042,6 +11661,7 @@ public function setInPersonSigningEnabled($in_person_signing_enabled) /** * Gets in_person_signing_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getInPersonSigningEnabledMetadata() @@ -10051,7 +11671,9 @@ public function getInPersonSigningEnabledMetadata() /** * Sets in_person_signing_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $in_person_signing_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $in_person_signing_enabled_metadata in_person_signing_enabled_metadata + * * @return $this */ public function setInPersonSigningEnabledMetadata($in_person_signing_enabled_metadata) @@ -10063,6 +11685,7 @@ public function setInPersonSigningEnabledMetadata($in_person_signing_enabled_met /** * Gets in_session_enabled + * * @return string */ public function getInSessionEnabled() @@ -10072,7 +11695,9 @@ public function getInSessionEnabled() /** * Sets in_session_enabled + * * @param string $in_session_enabled + * * @return $this */ public function setInSessionEnabled($in_session_enabled) @@ -10084,6 +11709,7 @@ public function setInSessionEnabled($in_session_enabled) /** * Gets in_session_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getInSessionEnabledMetadata() @@ -10093,7 +11719,9 @@ public function getInSessionEnabledMetadata() /** * Sets in_session_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $in_session_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $in_session_enabled_metadata in_session_enabled_metadata + * * @return $this */ public function setInSessionEnabledMetadata($in_session_enabled_metadata) @@ -10105,6 +11733,7 @@ public function setInSessionEnabledMetadata($in_session_enabled_metadata) /** * Gets in_session_suppress_emails + * * @return string */ public function getInSessionSuppressEmails() @@ -10114,7 +11743,9 @@ public function getInSessionSuppressEmails() /** * Sets in_session_suppress_emails + * * @param string $in_session_suppress_emails + * * @return $this */ public function setInSessionSuppressEmails($in_session_suppress_emails) @@ -10126,6 +11757,7 @@ public function setInSessionSuppressEmails($in_session_suppress_emails) /** * Gets in_session_suppress_emails_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getInSessionSuppressEmailsMetadata() @@ -10135,7 +11767,9 @@ public function getInSessionSuppressEmailsMetadata() /** * Sets in_session_suppress_emails_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $in_session_suppress_emails_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $in_session_suppress_emails_metadata in_session_suppress_emails_metadata + * * @return $this */ public function setInSessionSuppressEmailsMetadata($in_session_suppress_emails_metadata) @@ -10147,6 +11781,7 @@ public function setInSessionSuppressEmailsMetadata($in_session_suppress_emails_m /** * Gets maximum_signing_groups + * * @return string */ public function getMaximumSigningGroups() @@ -10156,7 +11791,9 @@ public function getMaximumSigningGroups() /** * Sets maximum_signing_groups + * * @param string $maximum_signing_groups + * * @return $this */ public function setMaximumSigningGroups($maximum_signing_groups) @@ -10168,6 +11805,7 @@ public function setMaximumSigningGroups($maximum_signing_groups) /** * Gets maximum_signing_groups_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getMaximumSigningGroupsMetadata() @@ -10177,7 +11815,9 @@ public function getMaximumSigningGroupsMetadata() /** * Sets maximum_signing_groups_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $maximum_signing_groups_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $maximum_signing_groups_metadata maximum_signing_groups_metadata + * * @return $this */ public function setMaximumSigningGroupsMetadata($maximum_signing_groups_metadata) @@ -10189,6 +11829,7 @@ public function setMaximumSigningGroupsMetadata($maximum_signing_groups_metadata /** * Gets maximum_users_per_signing_group + * * @return string */ public function getMaximumUsersPerSigningGroup() @@ -10198,7 +11839,9 @@ public function getMaximumUsersPerSigningGroup() /** * Sets maximum_users_per_signing_group + * * @param string $maximum_users_per_signing_group + * * @return $this */ public function setMaximumUsersPerSigningGroup($maximum_users_per_signing_group) @@ -10210,6 +11853,7 @@ public function setMaximumUsersPerSigningGroup($maximum_users_per_signing_group) /** * Gets maximum_users_per_signing_group_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getMaximumUsersPerSigningGroupMetadata() @@ -10219,7 +11863,9 @@ public function getMaximumUsersPerSigningGroupMetadata() /** * Sets maximum_users_per_signing_group_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $maximum_users_per_signing_group_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $maximum_users_per_signing_group_metadata maximum_users_per_signing_group_metadata + * * @return $this */ public function setMaximumUsersPerSigningGroupMetadata($maximum_users_per_signing_group_metadata) @@ -10231,6 +11877,7 @@ public function setMaximumUsersPerSigningGroupMetadata($maximum_users_per_signin /** * Gets max_number_of_custom_stamps + * * @return string */ public function getMaxNumberOfCustomStamps() @@ -10240,7 +11887,9 @@ public function getMaxNumberOfCustomStamps() /** * Sets max_number_of_custom_stamps + * * @param string $max_number_of_custom_stamps + * * @return $this */ public function setMaxNumberOfCustomStamps($max_number_of_custom_stamps) @@ -10252,6 +11901,7 @@ public function setMaxNumberOfCustomStamps($max_number_of_custom_stamps) /** * Gets mobile_session_timeout + * * @return string */ public function getMobileSessionTimeout() @@ -10261,7 +11911,9 @@ public function getMobileSessionTimeout() /** * Sets mobile_session_timeout + * * @param string $mobile_session_timeout + * * @return $this */ public function setMobileSessionTimeout($mobile_session_timeout) @@ -10273,6 +11925,7 @@ public function setMobileSessionTimeout($mobile_session_timeout) /** * Gets mobile_session_timeout_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getMobileSessionTimeoutMetadata() @@ -10282,7 +11935,9 @@ public function getMobileSessionTimeoutMetadata() /** * Sets mobile_session_timeout_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $mobile_session_timeout_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $mobile_session_timeout_metadata mobile_session_timeout_metadata + * * @return $this */ public function setMobileSessionTimeoutMetadata($mobile_session_timeout_metadata) @@ -10294,6 +11949,7 @@ public function setMobileSessionTimeoutMetadata($mobile_session_timeout_metadata /** * Gets number_of_active_custom_stamps + * * @return string */ public function getNumberOfActiveCustomStamps() @@ -10303,7 +11959,9 @@ public function getNumberOfActiveCustomStamps() /** * Sets number_of_active_custom_stamps + * * @param string $number_of_active_custom_stamps + * * @return $this */ public function setNumberOfActiveCustomStamps($number_of_active_custom_stamps) @@ -10315,6 +11973,7 @@ public function setNumberOfActiveCustomStamps($number_of_active_custom_stamps) /** * Gets opt_in_mobile_signing_v02 + * * @return string */ public function getOptInMobileSigningV02() @@ -10324,7 +11983,9 @@ public function getOptInMobileSigningV02() /** * Sets opt_in_mobile_signing_v02 + * * @param string $opt_in_mobile_signing_v02 + * * @return $this */ public function setOptInMobileSigningV02($opt_in_mobile_signing_v02) @@ -10336,6 +11997,7 @@ public function setOptInMobileSigningV02($opt_in_mobile_signing_v02) /** * Gets opt_in_mobile_signing_v02_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getOptInMobileSigningV02Metadata() @@ -10345,7 +12007,9 @@ public function getOptInMobileSigningV02Metadata() /** * Sets opt_in_mobile_signing_v02_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $opt_in_mobile_signing_v02_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $opt_in_mobile_signing_v02_metadata opt_in_mobile_signing_v02_metadata + * * @return $this */ public function setOptInMobileSigningV02Metadata($opt_in_mobile_signing_v02_metadata) @@ -10357,6 +12021,7 @@ public function setOptInMobileSigningV02Metadata($opt_in_mobile_signing_v02_meta /** * Gets opt_out_auto_nav_text_and_tab_color_updates + * * @return string */ public function getOptOutAutoNavTextAndTabColorUpdates() @@ -10366,7 +12031,9 @@ public function getOptOutAutoNavTextAndTabColorUpdates() /** * Sets opt_out_auto_nav_text_and_tab_color_updates + * * @param string $opt_out_auto_nav_text_and_tab_color_updates + * * @return $this */ public function setOptOutAutoNavTextAndTabColorUpdates($opt_out_auto_nav_text_and_tab_color_updates) @@ -10378,6 +12045,7 @@ public function setOptOutAutoNavTextAndTabColorUpdates($opt_out_auto_nav_text_an /** * Gets opt_out_auto_nav_text_and_tab_color_updates_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getOptOutAutoNavTextAndTabColorUpdatesMetadata() @@ -10387,7 +12055,9 @@ public function getOptOutAutoNavTextAndTabColorUpdatesMetadata() /** * Sets opt_out_auto_nav_text_and_tab_color_updates_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $opt_out_auto_nav_text_and_tab_color_updates_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $opt_out_auto_nav_text_and_tab_color_updates_metadata opt_out_auto_nav_text_and_tab_color_updates_metadata + * * @return $this */ public function setOptOutAutoNavTextAndTabColorUpdatesMetadata($opt_out_auto_nav_text_and_tab_color_updates_metadata) @@ -10399,6 +12069,7 @@ public function setOptOutAutoNavTextAndTabColorUpdatesMetadata($opt_out_auto_nav /** * Gets opt_out_new_platform_seal + * * @return string */ public function getOptOutNewPlatformSeal() @@ -10408,7 +12079,9 @@ public function getOptOutNewPlatformSeal() /** * Sets opt_out_new_platform_seal + * * @param string $opt_out_new_platform_seal + * * @return $this */ public function setOptOutNewPlatformSeal($opt_out_new_platform_seal) @@ -10420,6 +12093,7 @@ public function setOptOutNewPlatformSeal($opt_out_new_platform_seal) /** * Gets opt_out_new_platform_seal_platform_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getOptOutNewPlatformSealPlatformMetadata() @@ -10429,7 +12103,9 @@ public function getOptOutNewPlatformSealPlatformMetadata() /** * Sets opt_out_new_platform_seal_platform_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $opt_out_new_platform_seal_platform_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $opt_out_new_platform_seal_platform_metadata opt_out_new_platform_seal_platform_metadata + * * @return $this */ public function setOptOutNewPlatformSealPlatformMetadata($opt_out_new_platform_seal_platform_metadata) @@ -10441,6 +12117,7 @@ public function setOptOutNewPlatformSealPlatformMetadata($opt_out_new_platform_s /** * Gets phone_auth_recipient_may_provide_phone_number + * * @return string */ public function getPhoneAuthRecipientMayProvidePhoneNumber() @@ -10450,7 +12127,9 @@ public function getPhoneAuthRecipientMayProvidePhoneNumber() /** * Sets phone_auth_recipient_may_provide_phone_number + * * @param string $phone_auth_recipient_may_provide_phone_number + * * @return $this */ public function setPhoneAuthRecipientMayProvidePhoneNumber($phone_auth_recipient_may_provide_phone_number) @@ -10462,6 +12141,7 @@ public function setPhoneAuthRecipientMayProvidePhoneNumber($phone_auth_recipient /** * Gets phone_auth_recipient_may_provide_phone_number_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getPhoneAuthRecipientMayProvidePhoneNumberMetadata() @@ -10471,7 +12151,9 @@ public function getPhoneAuthRecipientMayProvidePhoneNumberMetadata() /** * Sets phone_auth_recipient_may_provide_phone_number_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $phone_auth_recipient_may_provide_phone_number_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $phone_auth_recipient_may_provide_phone_number_metadata phone_auth_recipient_may_provide_phone_number_metadata + * * @return $this */ public function setPhoneAuthRecipientMayProvidePhoneNumberMetadata($phone_auth_recipient_may_provide_phone_number_metadata) @@ -10483,6 +12165,7 @@ public function setPhoneAuthRecipientMayProvidePhoneNumberMetadata($phone_auth_r /** * Gets pki_sign_downloaded_pdf_docs + * * @return string */ public function getPkiSignDownloadedPdfDocs() @@ -10492,7 +12175,9 @@ public function getPkiSignDownloadedPdfDocs() /** * Sets pki_sign_downloaded_pdf_docs + * * @param string $pki_sign_downloaded_pdf_docs + * * @return $this */ public function setPkiSignDownloadedPdfDocs($pki_sign_downloaded_pdf_docs) @@ -10504,6 +12189,7 @@ public function setPkiSignDownloadedPdfDocs($pki_sign_downloaded_pdf_docs) /** * Gets pki_sign_downloaded_pdf_docs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getPkiSignDownloadedPdfDocsMetadata() @@ -10513,7 +12199,9 @@ public function getPkiSignDownloadedPdfDocsMetadata() /** * Sets pki_sign_downloaded_pdf_docs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $pki_sign_downloaded_pdf_docs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $pki_sign_downloaded_pdf_docs_metadata pki_sign_downloaded_pdf_docs_metadata + * * @return $this */ public function setPkiSignDownloadedPdfDocsMetadata($pki_sign_downloaded_pdf_docs_metadata) @@ -10525,6 +12213,7 @@ public function setPkiSignDownloadedPdfDocsMetadata($pki_sign_downloaded_pdf_doc /** * Gets recipients_can_sign_offline + * * @return string */ public function getRecipientsCanSignOffline() @@ -10534,7 +12223,9 @@ public function getRecipientsCanSignOffline() /** * Sets recipients_can_sign_offline + * * @param string $recipients_can_sign_offline + * * @return $this */ public function setRecipientsCanSignOffline($recipients_can_sign_offline) @@ -10546,6 +12237,7 @@ public function setRecipientsCanSignOffline($recipients_can_sign_offline) /** * Gets recipients_can_sign_offline_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRecipientsCanSignOfflineMetadata() @@ -10555,7 +12247,9 @@ public function getRecipientsCanSignOfflineMetadata() /** * Sets recipients_can_sign_offline_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $recipients_can_sign_offline_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $recipients_can_sign_offline_metadata recipients_can_sign_offline_metadata + * * @return $this */ public function setRecipientsCanSignOfflineMetadata($recipients_can_sign_offline_metadata) @@ -10567,6 +12261,7 @@ public function setRecipientsCanSignOfflineMetadata($recipients_can_sign_offline /** * Gets recipient_signing_auto_navigation_control + * * @return string */ public function getRecipientSigningAutoNavigationControl() @@ -10576,7 +12271,9 @@ public function getRecipientSigningAutoNavigationControl() /** * Sets recipient_signing_auto_navigation_control + * * @param string $recipient_signing_auto_navigation_control + * * @return $this */ public function setRecipientSigningAutoNavigationControl($recipient_signing_auto_navigation_control) @@ -10588,6 +12285,7 @@ public function setRecipientSigningAutoNavigationControl($recipient_signing_auto /** * Gets recipient_signing_auto_navigation_control_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRecipientSigningAutoNavigationControlMetadata() @@ -10597,7 +12295,9 @@ public function getRecipientSigningAutoNavigationControlMetadata() /** * Sets recipient_signing_auto_navigation_control_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $recipient_signing_auto_navigation_control_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $recipient_signing_auto_navigation_control_metadata recipient_signing_auto_navigation_control_metadata + * * @return $this */ public function setRecipientSigningAutoNavigationControlMetadata($recipient_signing_auto_navigation_control_metadata) @@ -10609,6 +12309,7 @@ public function setRecipientSigningAutoNavigationControlMetadata($recipient_sign /** * Gets require21_cf_rpt11_compliance + * * @return string */ public function getRequire21CfRpt11Compliance() @@ -10618,7 +12319,9 @@ public function getRequire21CfRpt11Compliance() /** * Sets require21_cf_rpt11_compliance + * * @param string $require21_cf_rpt11_compliance + * * @return $this */ public function setRequire21CfRpt11Compliance($require21_cf_rpt11_compliance) @@ -10630,6 +12333,7 @@ public function setRequire21CfRpt11Compliance($require21_cf_rpt11_compliance) /** * Gets require21_cf_rpt11_compliance_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRequire21CfRpt11ComplianceMetadata() @@ -10639,7 +12343,9 @@ public function getRequire21CfRpt11ComplianceMetadata() /** * Sets require21_cf_rpt11_compliance_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $require21_cf_rpt11_compliance_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $require21_cf_rpt11_compliance_metadata require21_cf_rpt11_compliance_metadata + * * @return $this */ public function setRequire21CfRpt11ComplianceMetadata($require21_cf_rpt11_compliance_metadata) @@ -10651,6 +12357,7 @@ public function setRequire21CfRpt11ComplianceMetadata($require21_cf_rpt11_compli /** * Gets require_decline_reason + * * @return string */ public function getRequireDeclineReason() @@ -10660,7 +12367,9 @@ public function getRequireDeclineReason() /** * Sets require_decline_reason + * * @param string $require_decline_reason + * * @return $this */ public function setRequireDeclineReason($require_decline_reason) @@ -10672,6 +12381,7 @@ public function setRequireDeclineReason($require_decline_reason) /** * Gets require_decline_reason_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRequireDeclineReasonMetadata() @@ -10681,7 +12391,9 @@ public function getRequireDeclineReasonMetadata() /** * Sets require_decline_reason_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $require_decline_reason_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $require_decline_reason_metadata require_decline_reason_metadata + * * @return $this */ public function setRequireDeclineReasonMetadata($require_decline_reason_metadata) @@ -10693,6 +12405,7 @@ public function setRequireDeclineReasonMetadata($require_decline_reason_metadata /** * Gets require_external_user_management + * * @return string */ public function getRequireExternalUserManagement() @@ -10702,7 +12415,9 @@ public function getRequireExternalUserManagement() /** * Sets require_external_user_management + * * @param string $require_external_user_management + * * @return $this */ public function setRequireExternalUserManagement($require_external_user_management) @@ -10714,6 +12429,7 @@ public function setRequireExternalUserManagement($require_external_user_manageme /** * Gets require_external_user_management_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRequireExternalUserManagementMetadata() @@ -10723,7 +12439,9 @@ public function getRequireExternalUserManagementMetadata() /** * Sets require_external_user_management_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $require_external_user_management_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $require_external_user_management_metadata require_external_user_management_metadata + * * @return $this */ public function setRequireExternalUserManagementMetadata($require_external_user_management_metadata) @@ -10735,6 +12453,7 @@ public function setRequireExternalUserManagementMetadata($require_external_user_ /** * Gets require_signer_certificate_type + * * @return string */ public function getRequireSignerCertificateType() @@ -10744,7 +12463,9 @@ public function getRequireSignerCertificateType() /** * Sets require_signer_certificate_type + * * @param string $require_signer_certificate_type + * * @return $this */ public function setRequireSignerCertificateType($require_signer_certificate_type) @@ -10756,6 +12477,7 @@ public function setRequireSignerCertificateType($require_signer_certificate_type /** * Gets require_signer_certificate_type_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRequireSignerCertificateTypeMetadata() @@ -10765,7 +12487,9 @@ public function getRequireSignerCertificateTypeMetadata() /** * Sets require_signer_certificate_type_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $require_signer_certificate_type_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $require_signer_certificate_type_metadata require_signer_certificate_type_metadata + * * @return $this */ public function setRequireSignerCertificateTypeMetadata($require_signer_certificate_type_metadata) @@ -10777,6 +12501,7 @@ public function setRequireSignerCertificateTypeMetadata($require_signer_certific /** * Gets rsa_verid_account_name + * * @return string */ public function getRsaVeridAccountName() @@ -10786,7 +12511,9 @@ public function getRsaVeridAccountName() /** * Sets rsa_verid_account_name + * * @param string $rsa_verid_account_name + * * @return $this */ public function setRsaVeridAccountName($rsa_verid_account_name) @@ -10798,6 +12525,7 @@ public function setRsaVeridAccountName($rsa_verid_account_name) /** * Gets rsa_verid_password + * * @return string */ public function getRsaVeridPassword() @@ -10807,7 +12535,9 @@ public function getRsaVeridPassword() /** * Sets rsa_verid_password + * * @param string $rsa_verid_password + * * @return $this */ public function setRsaVeridPassword($rsa_verid_password) @@ -10819,6 +12549,7 @@ public function setRsaVeridPassword($rsa_verid_password) /** * Gets rsa_verid_ruleset + * * @return string */ public function getRsaVeridRuleset() @@ -10828,7 +12559,9 @@ public function getRsaVeridRuleset() /** * Sets rsa_verid_ruleset + * * @param string $rsa_verid_ruleset + * * @return $this */ public function setRsaVeridRuleset($rsa_verid_ruleset) @@ -10840,6 +12573,7 @@ public function setRsaVeridRuleset($rsa_verid_ruleset) /** * Gets rsa_verid_user_id + * * @return string */ public function getRsaVeridUserId() @@ -10849,7 +12583,9 @@ public function getRsaVeridUserId() /** * Sets rsa_verid_user_id + * * @param string $rsa_verid_user_id + * * @return $this */ public function setRsaVeridUserId($rsa_verid_user_id) @@ -10861,6 +12597,7 @@ public function setRsaVeridUserId($rsa_verid_user_id) /** * Gets self_signed_recipient_email_document + * * @return string */ public function getSelfSignedRecipientEmailDocument() @@ -10870,7 +12607,9 @@ public function getSelfSignedRecipientEmailDocument() /** * Sets self_signed_recipient_email_document + * * @param string $self_signed_recipient_email_document + * * @return $this */ public function setSelfSignedRecipientEmailDocument($self_signed_recipient_email_document) @@ -10882,6 +12621,7 @@ public function setSelfSignedRecipientEmailDocument($self_signed_recipient_email /** * Gets self_signed_recipient_email_document_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSelfSignedRecipientEmailDocumentMetadata() @@ -10891,7 +12631,9 @@ public function getSelfSignedRecipientEmailDocumentMetadata() /** * Sets self_signed_recipient_email_document_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $self_signed_recipient_email_document_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $self_signed_recipient_email_document_metadata self_signed_recipient_email_document_metadata + * * @return $this */ public function setSelfSignedRecipientEmailDocumentMetadata($self_signed_recipient_email_document_metadata) @@ -10903,6 +12645,7 @@ public function setSelfSignedRecipientEmailDocumentMetadata($self_signed_recipie /** * Gets self_signed_recipient_email_document_user_override + * * @return string */ public function getSelfSignedRecipientEmailDocumentUserOverride() @@ -10912,7 +12655,9 @@ public function getSelfSignedRecipientEmailDocumentUserOverride() /** * Sets self_signed_recipient_email_document_user_override + * * @param string $self_signed_recipient_email_document_user_override + * * @return $this */ public function setSelfSignedRecipientEmailDocumentUserOverride($self_signed_recipient_email_document_user_override) @@ -10924,6 +12669,7 @@ public function setSelfSignedRecipientEmailDocumentUserOverride($self_signed_rec /** * Gets self_signed_recipient_email_document_user_override_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSelfSignedRecipientEmailDocumentUserOverrideMetadata() @@ -10933,7 +12679,9 @@ public function getSelfSignedRecipientEmailDocumentUserOverrideMetadata() /** * Sets self_signed_recipient_email_document_user_override_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $self_signed_recipient_email_document_user_override_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $self_signed_recipient_email_document_user_override_metadata self_signed_recipient_email_document_user_override_metadata + * * @return $this */ public function setSelfSignedRecipientEmailDocumentUserOverrideMetadata($self_signed_recipient_email_document_user_override_metadata) @@ -10945,6 +12693,7 @@ public function setSelfSignedRecipientEmailDocumentUserOverrideMetadata($self_si /** * Gets sender_can_sign_in_each_location + * * @return string */ public function getSenderCanSignInEachLocation() @@ -10954,7 +12703,9 @@ public function getSenderCanSignInEachLocation() /** * Sets sender_can_sign_in_each_location + * * @param string $sender_can_sign_in_each_location + * * @return $this */ public function setSenderCanSignInEachLocation($sender_can_sign_in_each_location) @@ -10966,6 +12717,7 @@ public function setSenderCanSignInEachLocation($sender_can_sign_in_each_location /** * Gets sender_can_sign_in_each_location_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSenderCanSignInEachLocationMetadata() @@ -10975,7 +12727,9 @@ public function getSenderCanSignInEachLocationMetadata() /** * Sets sender_can_sign_in_each_location_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sender_can_sign_in_each_location_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sender_can_sign_in_each_location_metadata sender_can_sign_in_each_location_metadata + * * @return $this */ public function setSenderCanSignInEachLocationMetadata($sender_can_sign_in_each_location_metadata) @@ -10987,6 +12741,7 @@ public function setSenderCanSignInEachLocationMetadata($sender_can_sign_in_each_ /** * Gets sender_must_authenticate_signing + * * @return string */ public function getSenderMustAuthenticateSigning() @@ -10996,7 +12751,9 @@ public function getSenderMustAuthenticateSigning() /** * Sets sender_must_authenticate_signing + * * @param string $sender_must_authenticate_signing + * * @return $this */ public function setSenderMustAuthenticateSigning($sender_must_authenticate_signing) @@ -11008,6 +12765,7 @@ public function setSenderMustAuthenticateSigning($sender_must_authenticate_signi /** * Gets sender_must_authenticate_signing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSenderMustAuthenticateSigningMetadata() @@ -11017,7 +12775,9 @@ public function getSenderMustAuthenticateSigningMetadata() /** * Sets sender_must_authenticate_signing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sender_must_authenticate_signing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sender_must_authenticate_signing_metadata sender_must_authenticate_signing_metadata + * * @return $this */ public function setSenderMustAuthenticateSigningMetadata($sender_must_authenticate_signing_metadata) @@ -11029,6 +12789,7 @@ public function setSenderMustAuthenticateSigningMetadata($sender_must_authentica /** * Gets sending_tags_font_color + * * @return string */ public function getSendingTagsFontColor() @@ -11038,7 +12799,9 @@ public function getSendingTagsFontColor() /** * Sets sending_tags_font_color + * * @param string $sending_tags_font_color + * * @return $this */ public function setSendingTagsFontColor($sending_tags_font_color) @@ -11050,6 +12813,7 @@ public function setSendingTagsFontColor($sending_tags_font_color) /** * Gets sending_tags_font_color_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSendingTagsFontColorMetadata() @@ -11059,7 +12823,9 @@ public function getSendingTagsFontColorMetadata() /** * Sets sending_tags_font_color_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sending_tags_font_color_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sending_tags_font_color_metadata sending_tags_font_color_metadata + * * @return $this */ public function setSendingTagsFontColorMetadata($sending_tags_font_color_metadata) @@ -11071,6 +12837,7 @@ public function setSendingTagsFontColorMetadata($sending_tags_font_color_metadat /** * Gets sending_tags_font_name + * * @return string */ public function getSendingTagsFontName() @@ -11080,7 +12847,9 @@ public function getSendingTagsFontName() /** * Sets sending_tags_font_name + * * @param string $sending_tags_font_name + * * @return $this */ public function setSendingTagsFontName($sending_tags_font_name) @@ -11092,6 +12861,7 @@ public function setSendingTagsFontName($sending_tags_font_name) /** * Gets sending_tags_font_name_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSendingTagsFontNameMetadata() @@ -11101,7 +12871,9 @@ public function getSendingTagsFontNameMetadata() /** * Sets sending_tags_font_name_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sending_tags_font_name_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sending_tags_font_name_metadata sending_tags_font_name_metadata + * * @return $this */ public function setSendingTagsFontNameMetadata($sending_tags_font_name_metadata) @@ -11113,6 +12885,7 @@ public function setSendingTagsFontNameMetadata($sending_tags_font_name_metadata) /** * Gets sending_tags_font_size + * * @return string */ public function getSendingTagsFontSize() @@ -11122,7 +12895,9 @@ public function getSendingTagsFontSize() /** * Sets sending_tags_font_size + * * @param string $sending_tags_font_size + * * @return $this */ public function setSendingTagsFontSize($sending_tags_font_size) @@ -11134,6 +12909,7 @@ public function setSendingTagsFontSize($sending_tags_font_size) /** * Gets sending_tags_font_size_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSendingTagsFontSizeMetadata() @@ -11143,7 +12919,9 @@ public function getSendingTagsFontSizeMetadata() /** * Sets sending_tags_font_size_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sending_tags_font_size_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sending_tags_font_size_metadata sending_tags_font_size_metadata + * * @return $this */ public function setSendingTagsFontSizeMetadata($sending_tags_font_size_metadata) @@ -11155,6 +12933,7 @@ public function setSendingTagsFontSizeMetadata($sending_tags_font_size_metadata) /** * Gets send_to_certified_delivery_enabled + * * @return string */ public function getSendToCertifiedDeliveryEnabled() @@ -11164,7 +12943,9 @@ public function getSendToCertifiedDeliveryEnabled() /** * Sets send_to_certified_delivery_enabled + * * @param string $send_to_certified_delivery_enabled + * * @return $this */ public function setSendToCertifiedDeliveryEnabled($send_to_certified_delivery_enabled) @@ -11176,6 +12957,7 @@ public function setSendToCertifiedDeliveryEnabled($send_to_certified_delivery_en /** * Gets send_to_certified_delivery_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSendToCertifiedDeliveryEnabledMetadata() @@ -11185,7 +12967,9 @@ public function getSendToCertifiedDeliveryEnabledMetadata() /** * Sets send_to_certified_delivery_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $send_to_certified_delivery_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $send_to_certified_delivery_enabled_metadata send_to_certified_delivery_enabled_metadata + * * @return $this */ public function setSendToCertifiedDeliveryEnabledMetadata($send_to_certified_delivery_enabled_metadata) @@ -11197,6 +12981,7 @@ public function setSendToCertifiedDeliveryEnabledMetadata($send_to_certified_del /** * Gets session_timeout + * * @return string */ public function getSessionTimeout() @@ -11206,7 +12991,9 @@ public function getSessionTimeout() /** * Sets session_timeout + * * @param string $session_timeout + * * @return $this */ public function setSessionTimeout($session_timeout) @@ -11218,6 +13005,7 @@ public function setSessionTimeout($session_timeout) /** * Gets session_timeout_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSessionTimeoutMetadata() @@ -11227,7 +13015,9 @@ public function getSessionTimeoutMetadata() /** * Sets session_timeout_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $session_timeout_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $session_timeout_metadata session_timeout_metadata + * * @return $this */ public function setSessionTimeoutMetadata($session_timeout_metadata) @@ -11239,6 +13029,7 @@ public function setSessionTimeoutMetadata($session_timeout_metadata) /** * Gets set_recip_email_lang + * * @return string */ public function getSetRecipEmailLang() @@ -11248,7 +13039,9 @@ public function getSetRecipEmailLang() /** * Sets set_recip_email_lang + * * @param string $set_recip_email_lang + * * @return $this */ public function setSetRecipEmailLang($set_recip_email_lang) @@ -11260,6 +13053,7 @@ public function setSetRecipEmailLang($set_recip_email_lang) /** * Gets set_recip_email_lang_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSetRecipEmailLangMetadata() @@ -11269,7 +13063,9 @@ public function getSetRecipEmailLangMetadata() /** * Sets set_recip_email_lang_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $set_recip_email_lang_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $set_recip_email_lang_metadata set_recip_email_lang_metadata + * * @return $this */ public function setSetRecipEmailLangMetadata($set_recip_email_lang_metadata) @@ -11281,6 +13077,7 @@ public function setSetRecipEmailLangMetadata($set_recip_email_lang_metadata) /** * Gets set_recip_sign_lang + * * @return string */ public function getSetRecipSignLang() @@ -11290,7 +13087,9 @@ public function getSetRecipSignLang() /** * Sets set_recip_sign_lang + * * @param string $set_recip_sign_lang + * * @return $this */ public function setSetRecipSignLang($set_recip_sign_lang) @@ -11302,6 +13101,7 @@ public function setSetRecipSignLang($set_recip_sign_lang) /** * Gets set_recip_sign_lang_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSetRecipSignLangMetadata() @@ -11311,7 +13111,9 @@ public function getSetRecipSignLangMetadata() /** * Sets set_recip_sign_lang_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $set_recip_sign_lang_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $set_recip_sign_lang_metadata set_recip_sign_lang_metadata + * * @return $this */ public function setSetRecipSignLangMetadata($set_recip_sign_lang_metadata) @@ -11323,6 +13125,7 @@ public function setSetRecipSignLangMetadata($set_recip_sign_lang_metadata) /** * Gets shared_template_folders + * * @return string */ public function getSharedTemplateFolders() @@ -11332,7 +13135,9 @@ public function getSharedTemplateFolders() /** * Sets shared_template_folders + * * @param string $shared_template_folders + * * @return $this */ public function setSharedTemplateFolders($shared_template_folders) @@ -11344,6 +13149,7 @@ public function setSharedTemplateFolders($shared_template_folders) /** * Gets shared_template_folders_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSharedTemplateFoldersMetadata() @@ -11353,8 +13159,10 @@ public function getSharedTemplateFoldersMetadata() /** * Sets shared_template_folders_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $shared_template_folders_metadata - * @return $this + * + * @param \DocuSign\eSign\Model\SettingsMetadata $shared_template_folders_metadata shared_template_folders_metadata + * + * @return $this */ public function setSharedTemplateFoldersMetadata($shared_template_folders_metadata) { @@ -11365,6 +13173,7 @@ public function setSharedTemplateFoldersMetadata($shared_template_folders_metada /** * Gets show_complete_dialog_in_embedded_session + * * @return string */ public function getShowCompleteDialogInEmbeddedSession() @@ -11374,7 +13183,9 @@ public function getShowCompleteDialogInEmbeddedSession() /** * Sets show_complete_dialog_in_embedded_session + * * @param string $show_complete_dialog_in_embedded_session + * * @return $this */ public function setShowCompleteDialogInEmbeddedSession($show_complete_dialog_in_embedded_session) @@ -11386,6 +13197,7 @@ public function setShowCompleteDialogInEmbeddedSession($show_complete_dialog_in_ /** * Gets show_complete_dialog_in_embedded_session_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getShowCompleteDialogInEmbeddedSessionMetadata() @@ -11395,7 +13207,9 @@ public function getShowCompleteDialogInEmbeddedSessionMetadata() /** * Sets show_complete_dialog_in_embedded_session_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $show_complete_dialog_in_embedded_session_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $show_complete_dialog_in_embedded_session_metadata show_complete_dialog_in_embedded_session_metadata + * * @return $this */ public function setShowCompleteDialogInEmbeddedSessionMetadata($show_complete_dialog_in_embedded_session_metadata) @@ -11407,6 +13221,7 @@ public function setShowCompleteDialogInEmbeddedSessionMetadata($show_complete_di /** * Gets show_conditional_routing_on_send + * * @return string */ public function getShowConditionalRoutingOnSend() @@ -11416,7 +13231,9 @@ public function getShowConditionalRoutingOnSend() /** * Sets show_conditional_routing_on_send + * * @param string $show_conditional_routing_on_send + * * @return $this */ public function setShowConditionalRoutingOnSend($show_conditional_routing_on_send) @@ -11428,6 +13245,7 @@ public function setShowConditionalRoutingOnSend($show_conditional_routing_on_sen /** * Gets show_conditional_routing_on_send_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getShowConditionalRoutingOnSendMetadata() @@ -11437,7 +13255,9 @@ public function getShowConditionalRoutingOnSendMetadata() /** * Sets show_conditional_routing_on_send_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $show_conditional_routing_on_send_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $show_conditional_routing_on_send_metadata show_conditional_routing_on_send_metadata + * * @return $this */ public function setShowConditionalRoutingOnSendMetadata($show_conditional_routing_on_send_metadata) @@ -11449,6 +13269,7 @@ public function setShowConditionalRoutingOnSendMetadata($show_conditional_routin /** * Gets show_initial_conditional_fields + * * @return string */ public function getShowInitialConditionalFields() @@ -11458,7 +13279,9 @@ public function getShowInitialConditionalFields() /** * Sets show_initial_conditional_fields + * * @param string $show_initial_conditional_fields + * * @return $this */ public function setShowInitialConditionalFields($show_initial_conditional_fields) @@ -11470,6 +13293,7 @@ public function setShowInitialConditionalFields($show_initial_conditional_fields /** * Gets show_initial_conditional_fields_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getShowInitialConditionalFieldsMetadata() @@ -11479,7 +13303,9 @@ public function getShowInitialConditionalFieldsMetadata() /** * Sets show_initial_conditional_fields_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $show_initial_conditional_fields_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $show_initial_conditional_fields_metadata show_initial_conditional_fields_metadata + * * @return $this */ public function setShowInitialConditionalFieldsMetadata($show_initial_conditional_fields_metadata) @@ -11491,6 +13317,7 @@ public function setShowInitialConditionalFieldsMetadata($show_initial_conditiona /** * Gets show_localized_watermarks + * * @return string */ public function getShowLocalizedWatermarks() @@ -11500,7 +13327,9 @@ public function getShowLocalizedWatermarks() /** * Sets show_localized_watermarks + * * @param string $show_localized_watermarks + * * @return $this */ public function setShowLocalizedWatermarks($show_localized_watermarks) @@ -11512,6 +13341,7 @@ public function setShowLocalizedWatermarks($show_localized_watermarks) /** * Gets show_localized_watermarks_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getShowLocalizedWatermarksMetadata() @@ -11521,7 +13351,9 @@ public function getShowLocalizedWatermarksMetadata() /** * Sets show_localized_watermarks_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $show_localized_watermarks_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $show_localized_watermarks_metadata show_localized_watermarks_metadata + * * @return $this */ public function setShowLocalizedWatermarksMetadata($show_localized_watermarks_metadata) @@ -11533,6 +13365,7 @@ public function setShowLocalizedWatermarksMetadata($show_localized_watermarks_me /** * Gets show_tutorials + * * @return string */ public function getShowTutorials() @@ -11542,7 +13375,9 @@ public function getShowTutorials() /** * Sets show_tutorials + * * @param string $show_tutorials + * * @return $this */ public function setShowTutorials($show_tutorials) @@ -11554,6 +13389,7 @@ public function setShowTutorials($show_tutorials) /** * Gets show_tutorials_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getShowTutorialsMetadata() @@ -11563,7 +13399,9 @@ public function getShowTutorialsMetadata() /** * Sets show_tutorials_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $show_tutorials_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $show_tutorials_metadata show_tutorials_metadata + * * @return $this */ public function setShowTutorialsMetadata($show_tutorials_metadata) @@ -11575,6 +13413,7 @@ public function setShowTutorialsMetadata($show_tutorials_metadata) /** * Gets signature_providers + * * @return string[] */ public function getSignatureProviders() @@ -11584,7 +13423,9 @@ public function getSignatureProviders() /** * Sets signature_providers + * * @param string[] $signature_providers + * * @return $this */ public function setSignatureProviders($signature_providers) @@ -11596,6 +13437,7 @@ public function setSignatureProviders($signature_providers) /** * Gets signature_providers_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignatureProvidersMetadata() @@ -11605,7 +13447,9 @@ public function getSignatureProvidersMetadata() /** * Sets signature_providers_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signature_providers_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signature_providers_metadata signature_providers_metadata + * * @return $this */ public function setSignatureProvidersMetadata($signature_providers_metadata) @@ -11617,6 +13461,7 @@ public function setSignatureProvidersMetadata($signature_providers_metadata) /** * Gets sign_date_format + * * @return string */ public function getSignDateFormat() @@ -11626,7 +13471,9 @@ public function getSignDateFormat() /** * Sets sign_date_format + * * @param string $sign_date_format + * * @return $this */ public function setSignDateFormat($sign_date_format) @@ -11638,6 +13485,7 @@ public function setSignDateFormat($sign_date_format) /** * Gets sign_date_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignDateFormatMetadata() @@ -11647,7 +13495,9 @@ public function getSignDateFormatMetadata() /** * Sets sign_date_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sign_date_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sign_date_format_metadata sign_date_format_metadata + * * @return $this */ public function setSignDateFormatMetadata($sign_date_format_metadata) @@ -11659,6 +13509,7 @@ public function setSignDateFormatMetadata($sign_date_format_metadata) /** * Gets signer_attach_certificate_to_envelope_pdf + * * @return string */ public function getSignerAttachCertificateToEnvelopePdf() @@ -11668,7 +13519,9 @@ public function getSignerAttachCertificateToEnvelopePdf() /** * Sets signer_attach_certificate_to_envelope_pdf + * * @param string $signer_attach_certificate_to_envelope_pdf + * * @return $this */ public function setSignerAttachCertificateToEnvelopePdf($signer_attach_certificate_to_envelope_pdf) @@ -11680,6 +13533,7 @@ public function setSignerAttachCertificateToEnvelopePdf($signer_attach_certifica /** * Gets signer_attach_certificate_to_envelope_pdf_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignerAttachCertificateToEnvelopePdfMetadata() @@ -11689,7 +13543,9 @@ public function getSignerAttachCertificateToEnvelopePdfMetadata() /** * Sets signer_attach_certificate_to_envelope_pdf_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signer_attach_certificate_to_envelope_pdf_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signer_attach_certificate_to_envelope_pdf_metadata signer_attach_certificate_to_envelope_pdf_metadata + * * @return $this */ public function setSignerAttachCertificateToEnvelopePdfMetadata($signer_attach_certificate_to_envelope_pdf_metadata) @@ -11701,6 +13557,7 @@ public function setSignerAttachCertificateToEnvelopePdfMetadata($signer_attach_c /** * Gets signer_attach_concat + * * @return string */ public function getSignerAttachConcat() @@ -11710,7 +13567,9 @@ public function getSignerAttachConcat() /** * Sets signer_attach_concat + * * @param string $signer_attach_concat + * * @return $this */ public function setSignerAttachConcat($signer_attach_concat) @@ -11722,6 +13581,7 @@ public function setSignerAttachConcat($signer_attach_concat) /** * Gets signer_attach_concat_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignerAttachConcatMetadata() @@ -11731,7 +13591,9 @@ public function getSignerAttachConcatMetadata() /** * Sets signer_attach_concat_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signer_attach_concat_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signer_attach_concat_metadata signer_attach_concat_metadata + * * @return $this */ public function setSignerAttachConcatMetadata($signer_attach_concat_metadata) @@ -11743,6 +13605,7 @@ public function setSignerAttachConcatMetadata($signer_attach_concat_metadata) /** * Gets signer_can_create_account + * * @return string */ public function getSignerCanCreateAccount() @@ -11752,7 +13615,9 @@ public function getSignerCanCreateAccount() /** * Sets signer_can_create_account + * * @param string $signer_can_create_account + * * @return $this */ public function setSignerCanCreateAccount($signer_can_create_account) @@ -11764,6 +13629,7 @@ public function setSignerCanCreateAccount($signer_can_create_account) /** * Gets signer_can_create_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignerCanCreateAccountMetadata() @@ -11773,7 +13639,9 @@ public function getSignerCanCreateAccountMetadata() /** * Sets signer_can_create_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signer_can_create_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signer_can_create_account_metadata signer_can_create_account_metadata + * * @return $this */ public function setSignerCanCreateAccountMetadata($signer_can_create_account_metadata) @@ -11785,6 +13653,7 @@ public function setSignerCanCreateAccountMetadata($signer_can_create_account_met /** * Gets signer_can_sign_on_mobile + * * @return string */ public function getSignerCanSignOnMobile() @@ -11794,7 +13663,9 @@ public function getSignerCanSignOnMobile() /** * Sets signer_can_sign_on_mobile + * * @param string $signer_can_sign_on_mobile + * * @return $this */ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) @@ -11806,6 +13677,7 @@ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) /** * Gets signer_can_sign_on_mobile_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignerCanSignOnMobileMetadata() @@ -11815,7 +13687,9 @@ public function getSignerCanSignOnMobileMetadata() /** * Sets signer_can_sign_on_mobile_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signer_can_sign_on_mobile_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signer_can_sign_on_mobile_metadata signer_can_sign_on_mobile_metadata + * * @return $this */ public function setSignerCanSignOnMobileMetadata($signer_can_sign_on_mobile_metadata) @@ -11827,6 +13701,7 @@ public function setSignerCanSignOnMobileMetadata($signer_can_sign_on_mobile_meta /** * Gets signer_in_session_use_envelope_complete_email + * * @return string */ public function getSignerInSessionUseEnvelopeCompleteEmail() @@ -11836,7 +13711,9 @@ public function getSignerInSessionUseEnvelopeCompleteEmail() /** * Sets signer_in_session_use_envelope_complete_email + * * @param string $signer_in_session_use_envelope_complete_email + * * @return $this */ public function setSignerInSessionUseEnvelopeCompleteEmail($signer_in_session_use_envelope_complete_email) @@ -11848,6 +13725,7 @@ public function setSignerInSessionUseEnvelopeCompleteEmail($signer_in_session_us /** * Gets signer_in_session_use_envelope_complete_email_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignerInSessionUseEnvelopeCompleteEmailMetadata() @@ -11857,7 +13735,9 @@ public function getSignerInSessionUseEnvelopeCompleteEmailMetadata() /** * Sets signer_in_session_use_envelope_complete_email_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signer_in_session_use_envelope_complete_email_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signer_in_session_use_envelope_complete_email_metadata signer_in_session_use_envelope_complete_email_metadata + * * @return $this */ public function setSignerInSessionUseEnvelopeCompleteEmailMetadata($signer_in_session_use_envelope_complete_email_metadata) @@ -11869,6 +13749,7 @@ public function setSignerInSessionUseEnvelopeCompleteEmailMetadata($signer_in_se /** * Gets signer_login_requirements + * * @return string */ public function getSignerLoginRequirements() @@ -11878,7 +13759,9 @@ public function getSignerLoginRequirements() /** * Sets signer_login_requirements + * * @param string $signer_login_requirements + * * @return $this */ public function setSignerLoginRequirements($signer_login_requirements) @@ -11890,6 +13773,7 @@ public function setSignerLoginRequirements($signer_login_requirements) /** * Gets signer_login_requirements_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignerLoginRequirementsMetadata() @@ -11899,7 +13783,9 @@ public function getSignerLoginRequirementsMetadata() /** * Sets signer_login_requirements_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signer_login_requirements_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signer_login_requirements_metadata signer_login_requirements_metadata + * * @return $this */ public function setSignerLoginRequirementsMetadata($signer_login_requirements_metadata) @@ -11911,6 +13797,7 @@ public function setSignerLoginRequirementsMetadata($signer_login_requirements_me /** * Gets signer_must_have_account + * * @return string */ public function getSignerMustHaveAccount() @@ -11920,7 +13807,9 @@ public function getSignerMustHaveAccount() /** * Sets signer_must_have_account + * * @param string $signer_must_have_account + * * @return $this */ public function setSignerMustHaveAccount($signer_must_have_account) @@ -11932,6 +13821,7 @@ public function setSignerMustHaveAccount($signer_must_have_account) /** * Gets signer_must_have_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignerMustHaveAccountMetadata() @@ -11941,7 +13831,9 @@ public function getSignerMustHaveAccountMetadata() /** * Sets signer_must_have_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signer_must_have_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signer_must_have_account_metadata signer_must_have_account_metadata + * * @return $this */ public function setSignerMustHaveAccountMetadata($signer_must_have_account_metadata) @@ -11953,6 +13845,7 @@ public function setSignerMustHaveAccountMetadata($signer_must_have_account_metad /** * Gets signer_must_login_to_sign + * * @return string */ public function getSignerMustLoginToSign() @@ -11962,7 +13855,9 @@ public function getSignerMustLoginToSign() /** * Sets signer_must_login_to_sign + * * @param string $signer_must_login_to_sign + * * @return $this */ public function setSignerMustLoginToSign($signer_must_login_to_sign) @@ -11974,6 +13869,7 @@ public function setSignerMustLoginToSign($signer_must_login_to_sign) /** * Gets signer_must_login_to_sign_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignerMustLoginToSignMetadata() @@ -11983,7 +13879,9 @@ public function getSignerMustLoginToSignMetadata() /** * Sets signer_must_login_to_sign_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signer_must_login_to_sign_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signer_must_login_to_sign_metadata signer_must_login_to_sign_metadata + * * @return $this */ public function setSignerMustLoginToSignMetadata($signer_must_login_to_sign_metadata) @@ -11995,6 +13893,7 @@ public function setSignerMustLoginToSignMetadata($signer_must_login_to_sign_meta /** * Gets signer_show_secure_field_initial_values + * * @return string */ public function getSignerShowSecureFieldInitialValues() @@ -12004,7 +13903,9 @@ public function getSignerShowSecureFieldInitialValues() /** * Sets signer_show_secure_field_initial_values + * * @param string $signer_show_secure_field_initial_values + * * @return $this */ public function setSignerShowSecureFieldInitialValues($signer_show_secure_field_initial_values) @@ -12016,6 +13917,7 @@ public function setSignerShowSecureFieldInitialValues($signer_show_secure_field_ /** * Gets signer_show_secure_field_initial_values_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignerShowSecureFieldInitialValuesMetadata() @@ -12025,7 +13927,9 @@ public function getSignerShowSecureFieldInitialValuesMetadata() /** * Sets signer_show_secure_field_initial_values_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signer_show_secure_field_initial_values_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signer_show_secure_field_initial_values_metadata signer_show_secure_field_initial_values_metadata + * * @return $this */ public function setSignerShowSecureFieldInitialValuesMetadata($signer_show_secure_field_initial_values_metadata) @@ -12037,6 +13941,7 @@ public function setSignerShowSecureFieldInitialValuesMetadata($signer_show_secur /** * Gets signing_session_timeout + * * @return string */ public function getSigningSessionTimeout() @@ -12046,7 +13951,9 @@ public function getSigningSessionTimeout() /** * Sets signing_session_timeout + * * @param string $signing_session_timeout + * * @return $this */ public function setSigningSessionTimeout($signing_session_timeout) @@ -12058,6 +13965,7 @@ public function setSigningSessionTimeout($signing_session_timeout) /** * Gets signing_session_timeout_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSigningSessionTimeoutMetadata() @@ -12067,7 +13975,9 @@ public function getSigningSessionTimeoutMetadata() /** * Sets signing_session_timeout_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signing_session_timeout_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signing_session_timeout_metadata signing_session_timeout_metadata + * * @return $this */ public function setSigningSessionTimeoutMetadata($signing_session_timeout_metadata) @@ -12079,6 +13989,7 @@ public function setSigningSessionTimeoutMetadata($signing_session_timeout_metada /** * Gets signing_ui_version + * * @return string */ public function getSigningUiVersion() @@ -12088,7 +13999,9 @@ public function getSigningUiVersion() /** * Sets signing_ui_version + * * @param string $signing_ui_version + * * @return $this */ public function setSigningUiVersion($signing_ui_version) @@ -12100,6 +14013,7 @@ public function setSigningUiVersion($signing_ui_version) /** * Gets signing_ui_version_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSigningUiVersionMetadata() @@ -12109,7 +14023,9 @@ public function getSigningUiVersionMetadata() /** * Sets signing_ui_version_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $signing_ui_version_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $signing_ui_version_metadata signing_ui_version_metadata + * * @return $this */ public function setSigningUiVersionMetadata($signing_ui_version_metadata) @@ -12121,6 +14037,7 @@ public function setSigningUiVersionMetadata($signing_ui_version_metadata) /** * Gets sign_time_format + * * @return string */ public function getSignTimeFormat() @@ -12130,7 +14047,9 @@ public function getSignTimeFormat() /** * Sets sign_time_format + * * @param string $sign_time_format + * * @return $this */ public function setSignTimeFormat($sign_time_format) @@ -12142,6 +14061,7 @@ public function setSignTimeFormat($sign_time_format) /** * Gets sign_time_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignTimeFormatMetadata() @@ -12151,7 +14071,9 @@ public function getSignTimeFormatMetadata() /** * Sets sign_time_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sign_time_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sign_time_format_metadata sign_time_format_metadata + * * @return $this */ public function setSignTimeFormatMetadata($sign_time_format_metadata) @@ -12163,6 +14085,7 @@ public function setSignTimeFormatMetadata($sign_time_format_metadata) /** * Gets sign_time_show_am_pm + * * @return string */ public function getSignTimeShowAmPm() @@ -12172,7 +14095,9 @@ public function getSignTimeShowAmPm() /** * Sets sign_time_show_am_pm + * * @param string $sign_time_show_am_pm + * * @return $this */ public function setSignTimeShowAmPm($sign_time_show_am_pm) @@ -12184,6 +14109,7 @@ public function setSignTimeShowAmPm($sign_time_show_am_pm) /** * Gets sign_time_show_am_pm_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignTimeShowAmPmMetadata() @@ -12193,7 +14119,9 @@ public function getSignTimeShowAmPmMetadata() /** * Sets sign_time_show_am_pm_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sign_time_show_am_pm_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sign_time_show_am_pm_metadata sign_time_show_am_pm_metadata + * * @return $this */ public function setSignTimeShowAmPmMetadata($sign_time_show_am_pm_metadata) @@ -12205,6 +14133,7 @@ public function setSignTimeShowAmPmMetadata($sign_time_show_am_pm_metadata) /** * Gets simplified_sending_enabled + * * @return string */ public function getSimplifiedSendingEnabled() @@ -12214,7 +14143,9 @@ public function getSimplifiedSendingEnabled() /** * Sets simplified_sending_enabled + * * @param string $simplified_sending_enabled + * * @return $this */ public function setSimplifiedSendingEnabled($simplified_sending_enabled) @@ -12226,6 +14157,7 @@ public function setSimplifiedSendingEnabled($simplified_sending_enabled) /** * Gets simplified_sending_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSimplifiedSendingEnabledMetadata() @@ -12235,7 +14167,9 @@ public function getSimplifiedSendingEnabledMetadata() /** * Sets simplified_sending_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $simplified_sending_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $simplified_sending_enabled_metadata simplified_sending_enabled_metadata + * * @return $this */ public function setSimplifiedSendingEnabledMetadata($simplified_sending_enabled_metadata) @@ -12247,6 +14181,7 @@ public function setSimplifiedSendingEnabledMetadata($simplified_sending_enabled_ /** * Gets single_sign_on_enabled + * * @return string */ public function getSingleSignOnEnabled() @@ -12256,7 +14191,9 @@ public function getSingleSignOnEnabled() /** * Sets single_sign_on_enabled + * * @param string $single_sign_on_enabled + * * @return $this */ public function setSingleSignOnEnabled($single_sign_on_enabled) @@ -12268,6 +14205,7 @@ public function setSingleSignOnEnabled($single_sign_on_enabled) /** * Gets single_sign_on_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSingleSignOnEnabledMetadata() @@ -12277,7 +14215,9 @@ public function getSingleSignOnEnabledMetadata() /** * Sets single_sign_on_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $single_sign_on_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $single_sign_on_enabled_metadata single_sign_on_enabled_metadata + * * @return $this */ public function setSingleSignOnEnabledMetadata($single_sign_on_enabled_metadata) @@ -12289,6 +14229,7 @@ public function setSingleSignOnEnabledMetadata($single_sign_on_enabled_metadata) /** * Gets skip_auth_completed_envelopes + * * @return string */ public function getSkipAuthCompletedEnvelopes() @@ -12298,7 +14239,9 @@ public function getSkipAuthCompletedEnvelopes() /** * Sets skip_auth_completed_envelopes + * * @param string $skip_auth_completed_envelopes + * * @return $this */ public function setSkipAuthCompletedEnvelopes($skip_auth_completed_envelopes) @@ -12310,6 +14253,7 @@ public function setSkipAuthCompletedEnvelopes($skip_auth_completed_envelopes) /** * Gets skip_auth_completed_envelopes_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSkipAuthCompletedEnvelopesMetadata() @@ -12319,7 +14263,9 @@ public function getSkipAuthCompletedEnvelopesMetadata() /** * Sets skip_auth_completed_envelopes_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $skip_auth_completed_envelopes_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $skip_auth_completed_envelopes_metadata skip_auth_completed_envelopes_metadata + * * @return $this */ public function setSkipAuthCompletedEnvelopesMetadata($skip_auth_completed_envelopes_metadata) @@ -12331,6 +14277,7 @@ public function setSkipAuthCompletedEnvelopesMetadata($skip_auth_completed_envel /** * Gets social_id_recip_auth + * * @return string */ public function getSocialIdRecipAuth() @@ -12340,7 +14287,9 @@ public function getSocialIdRecipAuth() /** * Sets social_id_recip_auth + * * @param string $social_id_recip_auth + * * @return $this */ public function setSocialIdRecipAuth($social_id_recip_auth) @@ -12352,6 +14301,7 @@ public function setSocialIdRecipAuth($social_id_recip_auth) /** * Gets social_id_recip_auth_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSocialIdRecipAuthMetadata() @@ -12361,7 +14311,9 @@ public function getSocialIdRecipAuthMetadata() /** * Sets social_id_recip_auth_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $social_id_recip_auth_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $social_id_recip_auth_metadata social_id_recip_auth_metadata + * * @return $this */ public function setSocialIdRecipAuthMetadata($social_id_recip_auth_metadata) @@ -12373,6 +14325,7 @@ public function setSocialIdRecipAuthMetadata($social_id_recip_auth_metadata) /** * Gets specify_document_visibility + * * @return string */ public function getSpecifyDocumentVisibility() @@ -12382,7 +14335,9 @@ public function getSpecifyDocumentVisibility() /** * Sets specify_document_visibility + * * @param string $specify_document_visibility + * * @return $this */ public function setSpecifyDocumentVisibility($specify_document_visibility) @@ -12394,6 +14349,7 @@ public function setSpecifyDocumentVisibility($specify_document_visibility) /** * Gets specify_document_visibility_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSpecifyDocumentVisibilityMetadata() @@ -12403,7 +14359,9 @@ public function getSpecifyDocumentVisibilityMetadata() /** * Sets specify_document_visibility_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $specify_document_visibility_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $specify_document_visibility_metadata specify_document_visibility_metadata + * * @return $this */ public function setSpecifyDocumentVisibilityMetadata($specify_document_visibility_metadata) @@ -12415,6 +14373,7 @@ public function setSpecifyDocumentVisibilityMetadata($specify_document_visibilit /** * Gets start_in_advanced_correct + * * @return string */ public function getStartInAdvancedCorrect() @@ -12424,7 +14383,9 @@ public function getStartInAdvancedCorrect() /** * Sets start_in_advanced_correct + * * @param string $start_in_advanced_correct + * * @return $this */ public function setStartInAdvancedCorrect($start_in_advanced_correct) @@ -12436,6 +14397,7 @@ public function setStartInAdvancedCorrect($start_in_advanced_correct) /** * Gets start_in_advanced_correct_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getStartInAdvancedCorrectMetadata() @@ -12445,7 +14407,9 @@ public function getStartInAdvancedCorrectMetadata() /** * Sets start_in_advanced_correct_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $start_in_advanced_correct_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $start_in_advanced_correct_metadata start_in_advanced_correct_metadata + * * @return $this */ public function setStartInAdvancedCorrectMetadata($start_in_advanced_correct_metadata) @@ -12457,6 +14421,7 @@ public function setStartInAdvancedCorrectMetadata($start_in_advanced_correct_met /** * Gets supplemental_documents_must_accept + * * @return string */ public function getSupplementalDocumentsMustAccept() @@ -12466,7 +14431,9 @@ public function getSupplementalDocumentsMustAccept() /** * Sets supplemental_documents_must_accept + * * @param string $supplemental_documents_must_accept + * * @return $this */ public function setSupplementalDocumentsMustAccept($supplemental_documents_must_accept) @@ -12478,6 +14445,7 @@ public function setSupplementalDocumentsMustAccept($supplemental_documents_must_ /** * Gets supplemental_documents_must_accept_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustAcceptMetadata() @@ -12487,7 +14455,9 @@ public function getSupplementalDocumentsMustAcceptMetadata() /** * Sets supplemental_documents_must_accept_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_accept_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_accept_metadata supplemental_documents_must_accept_metadata + * * @return $this */ public function setSupplementalDocumentsMustAcceptMetadata($supplemental_documents_must_accept_metadata) @@ -12499,6 +14469,7 @@ public function setSupplementalDocumentsMustAcceptMetadata($supplemental_documen /** * Gets supplemental_documents_must_read + * * @return string */ public function getSupplementalDocumentsMustRead() @@ -12508,7 +14479,9 @@ public function getSupplementalDocumentsMustRead() /** * Sets supplemental_documents_must_read + * * @param string $supplemental_documents_must_read + * * @return $this */ public function setSupplementalDocumentsMustRead($supplemental_documents_must_read) @@ -12520,6 +14493,7 @@ public function setSupplementalDocumentsMustRead($supplemental_documents_must_re /** * Gets supplemental_documents_must_read_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustReadMetadata() @@ -12529,7 +14503,9 @@ public function getSupplementalDocumentsMustReadMetadata() /** * Sets supplemental_documents_must_read_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_read_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_read_metadata supplemental_documents_must_read_metadata + * * @return $this */ public function setSupplementalDocumentsMustReadMetadata($supplemental_documents_must_read_metadata) @@ -12541,6 +14517,7 @@ public function setSupplementalDocumentsMustReadMetadata($supplemental_documents /** * Gets supplemental_documents_must_view + * * @return string */ public function getSupplementalDocumentsMustView() @@ -12550,7 +14527,9 @@ public function getSupplementalDocumentsMustView() /** * Sets supplemental_documents_must_view + * * @param string $supplemental_documents_must_view + * * @return $this */ public function setSupplementalDocumentsMustView($supplemental_documents_must_view) @@ -12562,6 +14541,7 @@ public function setSupplementalDocumentsMustView($supplemental_documents_must_vi /** * Gets supplemental_documents_must_view_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustViewMetadata() @@ -12571,7 +14551,9 @@ public function getSupplementalDocumentsMustViewMetadata() /** * Sets supplemental_documents_must_view_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_view_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_view_metadata supplemental_documents_must_view_metadata + * * @return $this */ public function setSupplementalDocumentsMustViewMetadata($supplemental_documents_must_view_metadata) @@ -12583,6 +14565,7 @@ public function setSupplementalDocumentsMustViewMetadata($supplemental_documents /** * Gets suppress_certificate_enforcement + * * @return string */ public function getSuppressCertificateEnforcement() @@ -12592,7 +14575,9 @@ public function getSuppressCertificateEnforcement() /** * Sets suppress_certificate_enforcement + * * @param string $suppress_certificate_enforcement + * * @return $this */ public function setSuppressCertificateEnforcement($suppress_certificate_enforcement) @@ -12604,6 +14589,7 @@ public function setSuppressCertificateEnforcement($suppress_certificate_enforcem /** * Gets suppress_certificate_enforcement_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSuppressCertificateEnforcementMetadata() @@ -12613,7 +14599,9 @@ public function getSuppressCertificateEnforcementMetadata() /** * Sets suppress_certificate_enforcement_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $suppress_certificate_enforcement_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $suppress_certificate_enforcement_metadata suppress_certificate_enforcement_metadata + * * @return $this */ public function setSuppressCertificateEnforcementMetadata($suppress_certificate_enforcement_metadata) @@ -12625,6 +14613,7 @@ public function setSuppressCertificateEnforcementMetadata($suppress_certificate_ /** * Gets tab_account_settings + * * @return \DocuSign\eSign\Model\TabAccountSettings */ public function getTabAccountSettings() @@ -12634,7 +14623,9 @@ public function getTabAccountSettings() /** * Sets tab_account_settings - * @param \DocuSign\eSign\Model\TabAccountSettings $tab_account_settings + * + * @param \DocuSign\eSign\Model\TabAccountSettings $tab_account_settings tab_account_settings + * * @return $this */ public function setTabAccountSettings($tab_account_settings) @@ -12646,6 +14637,7 @@ public function setTabAccountSettings($tab_account_settings) /** * Gets timezone_offset_api + * * @return string */ public function getTimezoneOffsetApi() @@ -12655,7 +14647,9 @@ public function getTimezoneOffsetApi() /** * Sets timezone_offset_api + * * @param string $timezone_offset_api + * * @return $this */ public function setTimezoneOffsetApi($timezone_offset_api) @@ -12667,6 +14661,7 @@ public function setTimezoneOffsetApi($timezone_offset_api) /** * Gets timezone_offset_api_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTimezoneOffsetApiMetadata() @@ -12676,7 +14671,9 @@ public function getTimezoneOffsetApiMetadata() /** * Sets timezone_offset_api_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_offset_api_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_offset_api_metadata timezone_offset_api_metadata + * * @return $this */ public function setTimezoneOffsetApiMetadata($timezone_offset_api_metadata) @@ -12688,6 +14685,7 @@ public function setTimezoneOffsetApiMetadata($timezone_offset_api_metadata) /** * Gets timezone_offset_ui + * * @return string */ public function getTimezoneOffsetUi() @@ -12697,7 +14695,9 @@ public function getTimezoneOffsetUi() /** * Sets timezone_offset_ui + * * @param string $timezone_offset_ui + * * @return $this */ public function setTimezoneOffsetUi($timezone_offset_ui) @@ -12709,6 +14709,7 @@ public function setTimezoneOffsetUi($timezone_offset_ui) /** * Gets timezone_offset_ui_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTimezoneOffsetUiMetadata() @@ -12718,7 +14719,9 @@ public function getTimezoneOffsetUiMetadata() /** * Sets timezone_offset_ui_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_offset_ui_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_offset_ui_metadata timezone_offset_ui_metadata + * * @return $this */ public function setTimezoneOffsetUiMetadata($timezone_offset_ui_metadata) @@ -12730,6 +14733,7 @@ public function setTimezoneOffsetUiMetadata($timezone_offset_ui_metadata) /** * Gets universal_signature_opt_in + * * @return string */ public function getUniversalSignatureOptIn() @@ -12739,7 +14743,9 @@ public function getUniversalSignatureOptIn() /** * Sets universal_signature_opt_in + * * @param string $universal_signature_opt_in + * * @return $this */ public function setUniversalSignatureOptIn($universal_signature_opt_in) @@ -12751,6 +14757,7 @@ public function setUniversalSignatureOptIn($universal_signature_opt_in) /** * Gets use_account_level_email + * * @return string */ public function getUseAccountLevelEmail() @@ -12760,7 +14767,9 @@ public function getUseAccountLevelEmail() /** * Sets use_account_level_email + * * @param string $use_account_level_email + * * @return $this */ public function setUseAccountLevelEmail($use_account_level_email) @@ -12772,6 +14781,7 @@ public function setUseAccountLevelEmail($use_account_level_email) /** * Gets use_account_level_email_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseAccountLevelEmailMetadata() @@ -12781,7 +14791,9 @@ public function getUseAccountLevelEmailMetadata() /** * Sets use_account_level_email_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_account_level_email_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_account_level_email_metadata use_account_level_email_metadata + * * @return $this */ public function setUseAccountLevelEmailMetadata($use_account_level_email_metadata) @@ -12793,6 +14805,7 @@ public function setUseAccountLevelEmailMetadata($use_account_level_email_metadat /** * Gets use_consumer_disclosure + * * @return string */ public function getUseConsumerDisclosure() @@ -12802,7 +14815,9 @@ public function getUseConsumerDisclosure() /** * Sets use_consumer_disclosure + * * @param string $use_consumer_disclosure + * * @return $this */ public function setUseConsumerDisclosure($use_consumer_disclosure) @@ -12814,6 +14829,7 @@ public function setUseConsumerDisclosure($use_consumer_disclosure) /** * Gets use_consumer_disclosure_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseConsumerDisclosureMetadata() @@ -12823,7 +14839,9 @@ public function getUseConsumerDisclosureMetadata() /** * Sets use_consumer_disclosure_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_consumer_disclosure_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_consumer_disclosure_metadata use_consumer_disclosure_metadata + * * @return $this */ public function setUseConsumerDisclosureMetadata($use_consumer_disclosure_metadata) @@ -12835,6 +14853,7 @@ public function setUseConsumerDisclosureMetadata($use_consumer_disclosure_metada /** * Gets use_consumer_disclosure_within_account + * * @return string */ public function getUseConsumerDisclosureWithinAccount() @@ -12844,7 +14863,9 @@ public function getUseConsumerDisclosureWithinAccount() /** * Sets use_consumer_disclosure_within_account + * * @param string $use_consumer_disclosure_within_account + * * @return $this */ public function setUseConsumerDisclosureWithinAccount($use_consumer_disclosure_within_account) @@ -12856,6 +14877,7 @@ public function setUseConsumerDisclosureWithinAccount($use_consumer_disclosure_w /** * Gets use_consumer_disclosure_within_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseConsumerDisclosureWithinAccountMetadata() @@ -12865,7 +14887,9 @@ public function getUseConsumerDisclosureWithinAccountMetadata() /** * Sets use_consumer_disclosure_within_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_consumer_disclosure_within_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_consumer_disclosure_within_account_metadata use_consumer_disclosure_within_account_metadata + * * @return $this */ public function setUseConsumerDisclosureWithinAccountMetadata($use_consumer_disclosure_within_account_metadata) @@ -12877,6 +14901,7 @@ public function setUseConsumerDisclosureWithinAccountMetadata($use_consumer_disc /** * Gets use_derived_keys + * * @return string */ public function getUseDerivedKeys() @@ -12886,7 +14911,9 @@ public function getUseDerivedKeys() /** * Sets use_derived_keys + * * @param string $use_derived_keys + * * @return $this */ public function setUseDerivedKeys($use_derived_keys) @@ -12898,6 +14925,7 @@ public function setUseDerivedKeys($use_derived_keys) /** * Gets use_derived_keys_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseDerivedKeysMetadata() @@ -12907,7 +14935,9 @@ public function getUseDerivedKeysMetadata() /** * Sets use_derived_keys_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_derived_keys_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_derived_keys_metadata use_derived_keys_metadata + * * @return $this */ public function setUseDerivedKeysMetadata($use_derived_keys_metadata) @@ -12919,6 +14949,7 @@ public function setUseDerivedKeysMetadata($use_derived_keys_metadata) /** * Gets use_docu_sign_express_signer_certificate + * * @return string */ public function getUseDocuSignExpressSignerCertificate() @@ -12928,7 +14959,9 @@ public function getUseDocuSignExpressSignerCertificate() /** * Sets use_docu_sign_express_signer_certificate + * * @param string $use_docu_sign_express_signer_certificate + * * @return $this */ public function setUseDocuSignExpressSignerCertificate($use_docu_sign_express_signer_certificate) @@ -12940,6 +14973,7 @@ public function setUseDocuSignExpressSignerCertificate($use_docu_sign_express_si /** * Gets use_docu_sign_express_signer_certificate_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseDocuSignExpressSignerCertificateMetadata() @@ -12949,7 +14983,9 @@ public function getUseDocuSignExpressSignerCertificateMetadata() /** * Sets use_docu_sign_express_signer_certificate_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_docu_sign_express_signer_certificate_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_docu_sign_express_signer_certificate_metadata use_docu_sign_express_signer_certificate_metadata + * * @return $this */ public function setUseDocuSignExpressSignerCertificateMetadata($use_docu_sign_express_signer_certificate_metadata) @@ -12961,6 +14997,7 @@ public function setUseDocuSignExpressSignerCertificateMetadata($use_docu_sign_ex /** * Gets use_multi_app_groups_data + * * @return string */ public function getUseMultiAppGroupsData() @@ -12970,7 +15007,9 @@ public function getUseMultiAppGroupsData() /** * Sets use_multi_app_groups_data + * * @param string $use_multi_app_groups_data + * * @return $this */ public function setUseMultiAppGroupsData($use_multi_app_groups_data) @@ -12982,6 +15021,7 @@ public function setUseMultiAppGroupsData($use_multi_app_groups_data) /** * Gets use_multi_app_groups_data_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseMultiAppGroupsDataMetadata() @@ -12991,7 +15031,9 @@ public function getUseMultiAppGroupsDataMetadata() /** * Sets use_multi_app_groups_data_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_multi_app_groups_data_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_multi_app_groups_data_metadata use_multi_app_groups_data_metadata + * * @return $this */ public function setUseMultiAppGroupsDataMetadata($use_multi_app_groups_data_metadata) @@ -13003,6 +15045,7 @@ public function setUseMultiAppGroupsDataMetadata($use_multi_app_groups_data_meta /** * Gets use_new_blob_for_pdf + * * @return string */ public function getUseNewBlobForPdf() @@ -13012,7 +15055,9 @@ public function getUseNewBlobForPdf() /** * Sets use_new_blob_for_pdf + * * @param string $use_new_blob_for_pdf + * * @return $this */ public function setUseNewBlobForPdf($use_new_blob_for_pdf) @@ -13024,6 +15069,7 @@ public function setUseNewBlobForPdf($use_new_blob_for_pdf) /** * Gets use_new_blob_for_pdf_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseNewBlobForPdfMetadata() @@ -13033,7 +15079,9 @@ public function getUseNewBlobForPdfMetadata() /** * Sets use_new_blob_for_pdf_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_new_blob_for_pdf_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_new_blob_for_pdf_metadata use_new_blob_for_pdf_metadata + * * @return $this */ public function setUseNewBlobForPdfMetadata($use_new_blob_for_pdf_metadata) @@ -13045,6 +15093,7 @@ public function setUseNewBlobForPdfMetadata($use_new_blob_for_pdf_metadata) /** * Gets use_safe_signer_certificates + * * @return string */ public function getUseSafeSignerCertificates() @@ -13054,7 +15103,9 @@ public function getUseSafeSignerCertificates() /** * Sets use_safe_signer_certificates + * * @param string $use_safe_signer_certificates + * * @return $this */ public function setUseSafeSignerCertificates($use_safe_signer_certificates) @@ -13066,6 +15117,7 @@ public function setUseSafeSignerCertificates($use_safe_signer_certificates) /** * Gets use_safe_signer_certificates_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseSafeSignerCertificatesMetadata() @@ -13075,7 +15127,9 @@ public function getUseSafeSignerCertificatesMetadata() /** * Sets use_safe_signer_certificates_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_safe_signer_certificates_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_safe_signer_certificates_metadata use_safe_signer_certificates_metadata + * * @return $this */ public function setUseSafeSignerCertificatesMetadata($use_safe_signer_certificates_metadata) @@ -13087,6 +15141,7 @@ public function setUseSafeSignerCertificatesMetadata($use_safe_signer_certificat /** * Gets uses_api + * * @return string */ public function getUsesApi() @@ -13096,7 +15151,9 @@ public function getUsesApi() /** * Sets uses_api + * * @param string $uses_api + * * @return $this */ public function setUsesApi($uses_api) @@ -13108,6 +15165,7 @@ public function setUsesApi($uses_api) /** * Gets uses_api_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUsesApiMetadata() @@ -13117,7 +15175,9 @@ public function getUsesApiMetadata() /** * Sets uses_api_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $uses_api_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $uses_api_metadata uses_api_metadata + * * @return $this */ public function setUsesApiMetadata($uses_api_metadata) @@ -13129,6 +15189,7 @@ public function setUsesApiMetadata($uses_api_metadata) /** * Gets use_signature_provider_platform + * * @return string */ public function getUseSignatureProviderPlatform() @@ -13138,7 +15199,9 @@ public function getUseSignatureProviderPlatform() /** * Sets use_signature_provider_platform + * * @param string $use_signature_provider_platform + * * @return $this */ public function setUseSignatureProviderPlatform($use_signature_provider_platform) @@ -13150,6 +15213,7 @@ public function setUseSignatureProviderPlatform($use_signature_provider_platform /** * Gets use_signature_provider_platform_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseSignatureProviderPlatformMetadata() @@ -13159,7 +15223,9 @@ public function getUseSignatureProviderPlatformMetadata() /** * Sets use_signature_provider_platform_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_signature_provider_platform_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_signature_provider_platform_metadata use_signature_provider_platform_metadata + * * @return $this */ public function setUseSignatureProviderPlatformMetadata($use_signature_provider_platform_metadata) @@ -13171,6 +15237,7 @@ public function setUseSignatureProviderPlatformMetadata($use_signature_provider_ /** * Gets validations_allowed + * * @return string */ public function getValidationsAllowed() @@ -13180,7 +15247,9 @@ public function getValidationsAllowed() /** * Sets validations_allowed + * * @param string $validations_allowed + * * @return $this */ public function setValidationsAllowed($validations_allowed) @@ -13192,6 +15261,7 @@ public function setValidationsAllowed($validations_allowed) /** * Gets validations_allowed_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getValidationsAllowedMetadata() @@ -13201,7 +15271,9 @@ public function getValidationsAllowedMetadata() /** * Sets validations_allowed_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $validations_allowed_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $validations_allowed_metadata validations_allowed_metadata + * * @return $this */ public function setValidationsAllowedMetadata($validations_allowed_metadata) @@ -13213,6 +15285,7 @@ public function setValidationsAllowedMetadata($validations_allowed_metadata) /** * Gets validations_brand + * * @return string */ public function getValidationsBrand() @@ -13222,7 +15295,9 @@ public function getValidationsBrand() /** * Sets validations_brand + * * @param string $validations_brand + * * @return $this */ public function setValidationsBrand($validations_brand) @@ -13234,6 +15309,7 @@ public function setValidationsBrand($validations_brand) /** * Gets validations_brand_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getValidationsBrandMetadata() @@ -13243,7 +15319,9 @@ public function getValidationsBrandMetadata() /** * Sets validations_brand_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $validations_brand_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $validations_brand_metadata validations_brand_metadata + * * @return $this */ public function setValidationsBrandMetadata($validations_brand_metadata) @@ -13255,6 +15333,7 @@ public function setValidationsBrandMetadata($validations_brand_metadata) /** * Gets validations_cadence + * * @return string */ public function getValidationsCadence() @@ -13264,7 +15343,9 @@ public function getValidationsCadence() /** * Sets validations_cadence + * * @param string $validations_cadence + * * @return $this */ public function setValidationsCadence($validations_cadence) @@ -13276,6 +15357,7 @@ public function setValidationsCadence($validations_cadence) /** * Gets validations_cadence_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getValidationsCadenceMetadata() @@ -13285,7 +15367,9 @@ public function getValidationsCadenceMetadata() /** * Sets validations_cadence_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $validations_cadence_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $validations_cadence_metadata validations_cadence_metadata + * * @return $this */ public function setValidationsCadenceMetadata($validations_cadence_metadata) @@ -13297,6 +15381,7 @@ public function setValidationsCadenceMetadata($validations_cadence_metadata) /** * Gets validations_enabled + * * @return string */ public function getValidationsEnabled() @@ -13306,7 +15391,9 @@ public function getValidationsEnabled() /** * Sets validations_enabled + * * @param string $validations_enabled + * * @return $this */ public function setValidationsEnabled($validations_enabled) @@ -13318,6 +15405,7 @@ public function setValidationsEnabled($validations_enabled) /** * Gets validations_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getValidationsEnabledMetadata() @@ -13327,7 +15415,9 @@ public function getValidationsEnabledMetadata() /** * Sets validations_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $validations_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $validations_enabled_metadata validations_enabled_metadata + * * @return $this */ public function setValidationsEnabledMetadata($validations_enabled_metadata) @@ -13339,6 +15429,7 @@ public function setValidationsEnabledMetadata($validations_enabled_metadata) /** * Gets validations_report + * * @return string */ public function getValidationsReport() @@ -13348,7 +15439,9 @@ public function getValidationsReport() /** * Sets validations_report + * * @param string $validations_report + * * @return $this */ public function setValidationsReport($validations_report) @@ -13360,6 +15453,7 @@ public function setValidationsReport($validations_report) /** * Gets validations_report_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getValidationsReportMetadata() @@ -13369,7 +15463,9 @@ public function getValidationsReportMetadata() /** * Sets validations_report_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $validations_report_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $validations_report_metadata validations_report_metadata + * * @return $this */ public function setValidationsReportMetadata($validations_report_metadata) @@ -13381,6 +15477,7 @@ public function setValidationsReportMetadata($validations_report_metadata) /** * Gets water_mark_enabled + * * @return string */ public function getWaterMarkEnabled() @@ -13390,7 +15487,9 @@ public function getWaterMarkEnabled() /** * Sets water_mark_enabled + * * @param string $water_mark_enabled + * * @return $this */ public function setWaterMarkEnabled($water_mark_enabled) @@ -13402,6 +15501,7 @@ public function setWaterMarkEnabled($water_mark_enabled) /** * Gets water_mark_enabled_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getWaterMarkEnabledMetadata() @@ -13411,7 +15511,9 @@ public function getWaterMarkEnabledMetadata() /** * Sets water_mark_enabled_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $water_mark_enabled_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $water_mark_enabled_metadata water_mark_enabled_metadata + * * @return $this */ public function setWaterMarkEnabledMetadata($water_mark_enabled_metadata) @@ -13423,6 +15525,7 @@ public function setWaterMarkEnabledMetadata($water_mark_enabled_metadata) /** * Gets write_reminder_to_envelope_history + * * @return string */ public function getWriteReminderToEnvelopeHistory() @@ -13432,7 +15535,9 @@ public function getWriteReminderToEnvelopeHistory() /** * Sets write_reminder_to_envelope_history + * * @param string $write_reminder_to_envelope_history + * * @return $this */ public function setWriteReminderToEnvelopeHistory($write_reminder_to_envelope_history) @@ -13444,6 +15549,7 @@ public function setWriteReminderToEnvelopeHistory($write_reminder_to_envelope_hi /** * Gets write_reminder_to_envelope_history_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getWriteReminderToEnvelopeHistoryMetadata() @@ -13453,7 +15559,9 @@ public function getWriteReminderToEnvelopeHistoryMetadata() /** * Sets write_reminder_to_envelope_history_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $write_reminder_to_envelope_history_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $write_reminder_to_envelope_history_metadata write_reminder_to_envelope_history_metadata + * * @return $this */ public function setWriteReminderToEnvelopeHistoryMetadata($write_reminder_to_envelope_history_metadata) @@ -13465,6 +15573,7 @@ public function setWriteReminderToEnvelopeHistoryMetadata($write_reminder_to_env /** * Gets wurfl_min_allowable_screen_size + * * @return string */ public function getWurflMinAllowableScreenSize() @@ -13474,7 +15583,9 @@ public function getWurflMinAllowableScreenSize() /** * Sets wurfl_min_allowable_screen_size + * * @param string $wurfl_min_allowable_screen_size + * * @return $this */ public function setWurflMinAllowableScreenSize($wurfl_min_allowable_screen_size) @@ -13486,6 +15597,7 @@ public function setWurflMinAllowableScreenSize($wurfl_min_allowable_screen_size) /** * Gets wurfl_min_allowable_screen_size_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getWurflMinAllowableScreenSizeMetadata() @@ -13495,7 +15607,9 @@ public function getWurflMinAllowableScreenSizeMetadata() /** * Sets wurfl_min_allowable_screen_size_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $wurfl_min_allowable_screen_size_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $wurfl_min_allowable_screen_size_metadata wurfl_min_allowable_screen_size_metadata + * * @return $this */ public function setWurflMinAllowableScreenSizeMetadata($wurfl_min_allowable_screen_size_metadata) @@ -13506,7 +15620,9 @@ public function setWurflMinAllowableScreenSizeMetadata($wurfl_min_allowable_scre } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -13516,7 +15632,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -13526,8 +15644,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -13541,7 +15661,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -13551,16 +15673,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountSharedAccess.php b/src/Model/AccountSharedAccess.php index fe242e50..f2000f20 100644 --- a/src/Model/AccountSharedAccess.php +++ b/src/Model/AccountSharedAccess.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountSharedAccess Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountSharedAccess implements ArrayAccess +class AccountSharedAccess implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountSharedAccess'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,47 @@ class AccountSharedAccess implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_id' => null, + 'end_position' => null, + 'error_details' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'shared_access' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -87,9 +124,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -104,9 +141,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -121,34 +158,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -164,30 +230,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_id + * * @return string */ public function getAccountId() @@ -197,7 +265,9 @@ public function getAccountId() /** * Sets account_id + * * @param string $account_id The account ID associated with the envelope. + * * @return $this */ public function setAccountId($account_id) @@ -209,6 +279,7 @@ public function setAccountId($account_id) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -218,7 +289,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -230,6 +303,7 @@ public function setEndPosition($end_position) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -239,7 +313,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -251,6 +327,7 @@ public function setErrorDetails($error_details) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -260,7 +337,9 @@ public function getNextUri() /** * 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) @@ -272,6 +351,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -281,7 +361,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -293,6 +375,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -302,7 +385,9 @@ public function getResultSetSize() /** * 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) @@ -314,6 +399,7 @@ public function setResultSetSize($result_set_size) /** * Gets shared_access + * * @return \DocuSign\eSign\Model\MemberSharedItems[] */ public function getSharedAccess() @@ -323,7 +409,9 @@ public function getSharedAccess() /** * Sets shared_access + * * @param \DocuSign\eSign\Model\MemberSharedItems[] $shared_access A complex type containing the shared access information to an envelope for the users specified in the request. + * * @return $this */ public function setSharedAccess($shared_access) @@ -335,6 +423,7 @@ public function setSharedAccess($shared_access) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -344,7 +433,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -356,6 +447,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -365,7 +457,9 @@ public function getTotalSetSize() /** * 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) @@ -376,7 +470,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -386,7 +482,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -396,8 +494,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -411,7 +511,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -421,16 +523,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountSignatureProvider.php b/src/Model/AccountSignatureProvider.php index e5c6c3f5..01cd4270 100644 --- a/src/Model/AccountSignatureProvider.php +++ b/src/Model/AccountSignatureProvider.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountSignatureProvider Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountSignatureProvider implements ArrayAccess +class AccountSignatureProvider implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountSignatureProvider'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class AccountSignatureProvider implements ArrayAccess 'signature_provider_required_options' => '\DocuSign\eSign\Model\SignatureProviderRequiredOption[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'is_required' => null, + 'priority' => null, + 'signature_provider_display_name' => null, + 'signature_provider_id' => null, + 'signature_provider_name' => null, + 'signature_provider_options_metadata' => null, + 'signature_provider_required_options' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'signature_provider_required_options' => 'signatureProviderRequiredOptions' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'signature_provider_required_options' => 'setSignatureProviderRequiredOptions' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'signature_provider_required_options' => 'getSignatureProviderRequiredOptions' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets is_required + * * @return string */ public function getIsRequired() @@ -186,7 +252,9 @@ public function getIsRequired() /** * Sets is_required + * * @param string $is_required + * * @return $this */ public function setIsRequired($is_required) @@ -198,6 +266,7 @@ public function setIsRequired($is_required) /** * Gets priority + * * @return string */ public function getPriority() @@ -207,7 +276,9 @@ public function getPriority() /** * Sets priority + * * @param string $priority + * * @return $this */ public function setPriority($priority) @@ -219,6 +290,7 @@ public function setPriority($priority) /** * Gets signature_provider_display_name + * * @return string */ public function getSignatureProviderDisplayName() @@ -228,7 +300,9 @@ public function getSignatureProviderDisplayName() /** * Sets signature_provider_display_name + * * @param string $signature_provider_display_name + * * @return $this */ public function setSignatureProviderDisplayName($signature_provider_display_name) @@ -240,6 +314,7 @@ public function setSignatureProviderDisplayName($signature_provider_display_name /** * Gets signature_provider_id + * * @return string */ public function getSignatureProviderId() @@ -249,7 +324,9 @@ public function getSignatureProviderId() /** * Sets signature_provider_id + * * @param string $signature_provider_id + * * @return $this */ public function setSignatureProviderId($signature_provider_id) @@ -261,6 +338,7 @@ public function setSignatureProviderId($signature_provider_id) /** * Gets signature_provider_name + * * @return string */ public function getSignatureProviderName() @@ -270,7 +348,9 @@ public function getSignatureProviderName() /** * Sets signature_provider_name + * * @param string $signature_provider_name + * * @return $this */ public function setSignatureProviderName($signature_provider_name) @@ -282,6 +362,7 @@ public function setSignatureProviderName($signature_provider_name) /** * Gets signature_provider_options_metadata + * * @return \DocuSign\eSign\Model\AccountSignatureProviderOption[] */ public function getSignatureProviderOptionsMetadata() @@ -291,7 +372,9 @@ public function getSignatureProviderOptionsMetadata() /** * Sets signature_provider_options_metadata + * * @param \DocuSign\eSign\Model\AccountSignatureProviderOption[] $signature_provider_options_metadata + * * @return $this */ public function setSignatureProviderOptionsMetadata($signature_provider_options_metadata) @@ -303,6 +386,7 @@ public function setSignatureProviderOptionsMetadata($signature_provider_options_ /** * Gets signature_provider_required_options + * * @return \DocuSign\eSign\Model\SignatureProviderRequiredOption[] */ public function getSignatureProviderRequiredOptions() @@ -312,7 +396,9 @@ public function getSignatureProviderRequiredOptions() /** * Sets signature_provider_required_options + * * @param \DocuSign\eSign\Model\SignatureProviderRequiredOption[] $signature_provider_required_options + * * @return $this */ public function setSignatureProviderRequiredOptions($signature_provider_required_options) @@ -323,7 +409,9 @@ public function setSignatureProviderRequiredOptions($signature_provider_required } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountSignatureProviderOption.php b/src/Model/AccountSignatureProviderOption.php index 2368a636..03f865c7 100644 --- a/src/Model/AccountSignatureProviderOption.php +++ b/src/Model/AccountSignatureProviderOption.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountSignatureProviderOption Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountSignatureProviderOption implements ArrayAccess +class AccountSignatureProviderOption implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountSignatureProviderOption'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class AccountSignatureProviderOption implements ArrayAccess 'signature_provider_option_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'signature_provider_option_display_name' => null, + 'signature_provider_option_id' => null, + 'signature_provider_option_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'signature_provider_option_name' => 'signatureProviderOptionName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'signature_provider_option_name' => 'setSignatureProviderOptionName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'signature_provider_option_name' => 'getSignatureProviderOptionName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets signature_provider_option_display_name + * * @return string */ public function getSignatureProviderOptionDisplayName() @@ -166,7 +228,9 @@ public function getSignatureProviderOptionDisplayName() /** * Sets signature_provider_option_display_name + * * @param string $signature_provider_option_display_name + * * @return $this */ public function setSignatureProviderOptionDisplayName($signature_provider_option_display_name) @@ -178,6 +242,7 @@ public function setSignatureProviderOptionDisplayName($signature_provider_option /** * Gets signature_provider_option_id + * * @return string */ public function getSignatureProviderOptionId() @@ -187,7 +252,9 @@ public function getSignatureProviderOptionId() /** * Sets signature_provider_option_id + * * @param string $signature_provider_option_id + * * @return $this */ public function setSignatureProviderOptionId($signature_provider_option_id) @@ -199,6 +266,7 @@ public function setSignatureProviderOptionId($signature_provider_option_id) /** * Gets signature_provider_option_name + * * @return string */ public function getSignatureProviderOptionName() @@ -208,7 +276,9 @@ public function getSignatureProviderOptionName() /** * Sets signature_provider_option_name + * * @param string $signature_provider_option_name + * * @return $this */ public function setSignatureProviderOptionName($signature_provider_option_name) @@ -219,7 +289,9 @@ public function setSignatureProviderOptionName($signature_provider_option_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountSignatureProviders.php b/src/Model/AccountSignatureProviders.php index 54cbd7d7..01ee9352 100644 --- a/src/Model/AccountSignatureProviders.php +++ b/src/Model/AccountSignatureProviders.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountSignatureProviders Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountSignatureProviders implements ArrayAccess +class AccountSignatureProviders implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountSignatureProviders'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'signature_providers' => '\DocuSign\eSign\Model\AccountSignatureProvider[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'signature_providers' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'signature_providers' => 'signatureProviders' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'signature_providers' => 'setSignatureProviders' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'signature_providers' => 'getSignatureProviders' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets signature_providers + * * @return \DocuSign\eSign\Model\AccountSignatureProvider[] */ public function getSignatureProviders() @@ -156,7 +216,9 @@ public function getSignatureProviders() /** * Sets signature_providers + * * @param \DocuSign\eSign\Model\AccountSignatureProvider[] $signature_providers + * * @return $this */ public function setSignatureProviders($signature_providers) @@ -167,7 +229,9 @@ public function setSignatureProviders($signature_providers) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AccountUISettings.php b/src/Model/AccountUISettings.php index f2bb8eff..e61b8a5e 100644 --- a/src/Model/AccountUISettings.php +++ b/src/Model/AccountUISettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AccountUISettings Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AccountUISettings implements ArrayAccess +class AccountUISettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'accountUISettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -80,13 +83,62 @@ class AccountUISettings implements ArrayAccess 'upload_new_image_to_sign_or_initial_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'admin_message' => null, + 'ask_an_admin' => null, + 'enable_admin_message' => null, + 'enable_admin_message_metadata' => null, + 'enable_easy_sign_can_use_multi_template_apply' => null, + 'enable_easy_sign_can_use_multi_template_apply_metadata' => null, + 'enable_easy_sign_template_upload' => null, + 'enable_easy_sign_template_upload_metadata' => null, + 'enable_envelope_copy_with_data' => null, + 'enable_envelope_copy_with_data_metadata' => null, + 'hide_send_an_envelope' => null, + 'hide_send_an_envelope_metadata' => null, + 'hide_use_a_template' => null, + 'hide_use_a_template_in_prepare' => null, + 'hide_use_a_template_in_prepare_metadata' => null, + 'hide_use_a_template_metadata' => null, + 'order_based_recipient_id_generation' => null, + 'order_based_recipient_id_generation_metadata' => null, + 'remove_envelope_forwarding' => null, + 'remove_envelope_forwarding_metadata' => null, + 'should_redact_access_code' => null, + 'should_redact_access_code_metadata' => null, + 'upload_new_image_to_sign_or_initial' => null, + 'upload_new_image_to_sign_or_initial_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -116,9 +168,9 @@ public static function swaggerTypes() 'upload_new_image_to_sign_or_initial_metadata' => 'uploadNewImageToSignOrInitialMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -148,9 +200,9 @@ public static function swaggerTypes() 'upload_new_image_to_sign_or_initial_metadata' => 'setUploadNewImageToSignOrInitialMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -180,34 +232,63 @@ public static function swaggerTypes() 'upload_new_image_to_sign_or_initial_metadata' => 'getUploadNewImageToSignOrInitialMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -238,30 +319,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets admin_message + * * @return \DocuSign\eSign\Model\AdminMessage */ public function getAdminMessage() @@ -271,7 +354,9 @@ public function getAdminMessage() /** * Sets admin_message - * @param \DocuSign\eSign\Model\AdminMessage $admin_message + * + * @param \DocuSign\eSign\Model\AdminMessage $admin_message admin_message + * * @return $this */ public function setAdminMessage($admin_message) @@ -283,6 +368,7 @@ public function setAdminMessage($admin_message) /** * Gets ask_an_admin + * * @return \DocuSign\eSign\Model\AskAnAdmin */ public function getAskAnAdmin() @@ -292,7 +378,9 @@ public function getAskAnAdmin() /** * Sets ask_an_admin - * @param \DocuSign\eSign\Model\AskAnAdmin $ask_an_admin + * + * @param \DocuSign\eSign\Model\AskAnAdmin $ask_an_admin ask_an_admin + * * @return $this */ public function setAskAnAdmin($ask_an_admin) @@ -304,6 +392,7 @@ public function setAskAnAdmin($ask_an_admin) /** * Gets enable_admin_message + * * @return string */ public function getEnableAdminMessage() @@ -313,7 +402,9 @@ public function getEnableAdminMessage() /** * Sets enable_admin_message + * * @param string $enable_admin_message + * * @return $this */ public function setEnableAdminMessage($enable_admin_message) @@ -325,6 +416,7 @@ public function setEnableAdminMessage($enable_admin_message) /** * Gets enable_admin_message_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableAdminMessageMetadata() @@ -334,7 +426,9 @@ public function getEnableAdminMessageMetadata() /** * Sets enable_admin_message_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_admin_message_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_admin_message_metadata enable_admin_message_metadata + * * @return $this */ public function setEnableAdminMessageMetadata($enable_admin_message_metadata) @@ -346,6 +440,7 @@ public function setEnableAdminMessageMetadata($enable_admin_message_metadata) /** * Gets enable_easy_sign_can_use_multi_template_apply + * * @return string */ public function getEnableEasySignCanUseMultiTemplateApply() @@ -355,7 +450,9 @@ public function getEnableEasySignCanUseMultiTemplateApply() /** * Sets enable_easy_sign_can_use_multi_template_apply + * * @param string $enable_easy_sign_can_use_multi_template_apply + * * @return $this */ public function setEnableEasySignCanUseMultiTemplateApply($enable_easy_sign_can_use_multi_template_apply) @@ -367,6 +464,7 @@ public function setEnableEasySignCanUseMultiTemplateApply($enable_easy_sign_can_ /** * Gets enable_easy_sign_can_use_multi_template_apply_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableEasySignCanUseMultiTemplateApplyMetadata() @@ -376,7 +474,9 @@ public function getEnableEasySignCanUseMultiTemplateApplyMetadata() /** * Sets enable_easy_sign_can_use_multi_template_apply_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_easy_sign_can_use_multi_template_apply_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_easy_sign_can_use_multi_template_apply_metadata enable_easy_sign_can_use_multi_template_apply_metadata + * * @return $this */ public function setEnableEasySignCanUseMultiTemplateApplyMetadata($enable_easy_sign_can_use_multi_template_apply_metadata) @@ -388,6 +488,7 @@ public function setEnableEasySignCanUseMultiTemplateApplyMetadata($enable_easy_s /** * Gets enable_easy_sign_template_upload + * * @return string */ public function getEnableEasySignTemplateUpload() @@ -397,7 +498,9 @@ public function getEnableEasySignTemplateUpload() /** * Sets enable_easy_sign_template_upload + * * @param string $enable_easy_sign_template_upload + * * @return $this */ public function setEnableEasySignTemplateUpload($enable_easy_sign_template_upload) @@ -409,6 +512,7 @@ public function setEnableEasySignTemplateUpload($enable_easy_sign_template_uploa /** * Gets enable_easy_sign_template_upload_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableEasySignTemplateUploadMetadata() @@ -418,7 +522,9 @@ public function getEnableEasySignTemplateUploadMetadata() /** * Sets enable_easy_sign_template_upload_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_easy_sign_template_upload_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_easy_sign_template_upload_metadata enable_easy_sign_template_upload_metadata + * * @return $this */ public function setEnableEasySignTemplateUploadMetadata($enable_easy_sign_template_upload_metadata) @@ -430,6 +536,7 @@ public function setEnableEasySignTemplateUploadMetadata($enable_easy_sign_templa /** * Gets enable_envelope_copy_with_data + * * @return string */ public function getEnableEnvelopeCopyWithData() @@ -439,7 +546,9 @@ public function getEnableEnvelopeCopyWithData() /** * Sets enable_envelope_copy_with_data + * * @param string $enable_envelope_copy_with_data + * * @return $this */ public function setEnableEnvelopeCopyWithData($enable_envelope_copy_with_data) @@ -451,6 +560,7 @@ public function setEnableEnvelopeCopyWithData($enable_envelope_copy_with_data) /** * Gets enable_envelope_copy_with_data_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableEnvelopeCopyWithDataMetadata() @@ -460,7 +570,9 @@ public function getEnableEnvelopeCopyWithDataMetadata() /** * Sets enable_envelope_copy_with_data_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_envelope_copy_with_data_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_envelope_copy_with_data_metadata enable_envelope_copy_with_data_metadata + * * @return $this */ public function setEnableEnvelopeCopyWithDataMetadata($enable_envelope_copy_with_data_metadata) @@ -472,6 +584,7 @@ public function setEnableEnvelopeCopyWithDataMetadata($enable_envelope_copy_with /** * Gets hide_send_an_envelope + * * @return string */ public function getHideSendAnEnvelope() @@ -481,7 +594,9 @@ public function getHideSendAnEnvelope() /** * Sets hide_send_an_envelope + * * @param string $hide_send_an_envelope + * * @return $this */ public function setHideSendAnEnvelope($hide_send_an_envelope) @@ -493,6 +608,7 @@ public function setHideSendAnEnvelope($hide_send_an_envelope) /** * Gets hide_send_an_envelope_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getHideSendAnEnvelopeMetadata() @@ -502,7 +618,9 @@ public function getHideSendAnEnvelopeMetadata() /** * Sets hide_send_an_envelope_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $hide_send_an_envelope_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $hide_send_an_envelope_metadata hide_send_an_envelope_metadata + * * @return $this */ public function setHideSendAnEnvelopeMetadata($hide_send_an_envelope_metadata) @@ -514,6 +632,7 @@ public function setHideSendAnEnvelopeMetadata($hide_send_an_envelope_metadata) /** * Gets hide_use_a_template + * * @return string */ public function getHideUseATemplate() @@ -523,7 +642,9 @@ public function getHideUseATemplate() /** * Sets hide_use_a_template + * * @param string $hide_use_a_template + * * @return $this */ public function setHideUseATemplate($hide_use_a_template) @@ -535,6 +656,7 @@ public function setHideUseATemplate($hide_use_a_template) /** * Gets hide_use_a_template_in_prepare + * * @return string */ public function getHideUseATemplateInPrepare() @@ -544,7 +666,9 @@ public function getHideUseATemplateInPrepare() /** * Sets hide_use_a_template_in_prepare + * * @param string $hide_use_a_template_in_prepare + * * @return $this */ public function setHideUseATemplateInPrepare($hide_use_a_template_in_prepare) @@ -556,6 +680,7 @@ public function setHideUseATemplateInPrepare($hide_use_a_template_in_prepare) /** * Gets hide_use_a_template_in_prepare_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getHideUseATemplateInPrepareMetadata() @@ -565,7 +690,9 @@ public function getHideUseATemplateInPrepareMetadata() /** * Sets hide_use_a_template_in_prepare_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $hide_use_a_template_in_prepare_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $hide_use_a_template_in_prepare_metadata hide_use_a_template_in_prepare_metadata + * * @return $this */ public function setHideUseATemplateInPrepareMetadata($hide_use_a_template_in_prepare_metadata) @@ -577,6 +704,7 @@ public function setHideUseATemplateInPrepareMetadata($hide_use_a_template_in_pre /** * Gets hide_use_a_template_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getHideUseATemplateMetadata() @@ -586,7 +714,9 @@ public function getHideUseATemplateMetadata() /** * Sets hide_use_a_template_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $hide_use_a_template_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $hide_use_a_template_metadata hide_use_a_template_metadata + * * @return $this */ public function setHideUseATemplateMetadata($hide_use_a_template_metadata) @@ -598,6 +728,7 @@ public function setHideUseATemplateMetadata($hide_use_a_template_metadata) /** * Gets order_based_recipient_id_generation + * * @return string */ public function getOrderBasedRecipientIdGeneration() @@ -607,7 +738,9 @@ public function getOrderBasedRecipientIdGeneration() /** * Sets order_based_recipient_id_generation + * * @param string $order_based_recipient_id_generation + * * @return $this */ public function setOrderBasedRecipientIdGeneration($order_based_recipient_id_generation) @@ -619,6 +752,7 @@ public function setOrderBasedRecipientIdGeneration($order_based_recipient_id_gen /** * Gets order_based_recipient_id_generation_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getOrderBasedRecipientIdGenerationMetadata() @@ -628,7 +762,9 @@ public function getOrderBasedRecipientIdGenerationMetadata() /** * Sets order_based_recipient_id_generation_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $order_based_recipient_id_generation_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $order_based_recipient_id_generation_metadata order_based_recipient_id_generation_metadata + * * @return $this */ public function setOrderBasedRecipientIdGenerationMetadata($order_based_recipient_id_generation_metadata) @@ -640,6 +776,7 @@ public function setOrderBasedRecipientIdGenerationMetadata($order_based_recipien /** * Gets remove_envelope_forwarding + * * @return string */ public function getRemoveEnvelopeForwarding() @@ -649,7 +786,9 @@ public function getRemoveEnvelopeForwarding() /** * Sets remove_envelope_forwarding + * * @param string $remove_envelope_forwarding + * * @return $this */ public function setRemoveEnvelopeForwarding($remove_envelope_forwarding) @@ -661,6 +800,7 @@ public function setRemoveEnvelopeForwarding($remove_envelope_forwarding) /** * Gets remove_envelope_forwarding_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRemoveEnvelopeForwardingMetadata() @@ -670,7 +810,9 @@ public function getRemoveEnvelopeForwardingMetadata() /** * Sets remove_envelope_forwarding_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $remove_envelope_forwarding_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $remove_envelope_forwarding_metadata remove_envelope_forwarding_metadata + * * @return $this */ public function setRemoveEnvelopeForwardingMetadata($remove_envelope_forwarding_metadata) @@ -682,6 +824,7 @@ public function setRemoveEnvelopeForwardingMetadata($remove_envelope_forwarding_ /** * Gets should_redact_access_code + * * @return string */ public function getShouldRedactAccessCode() @@ -691,7 +834,9 @@ public function getShouldRedactAccessCode() /** * Sets should_redact_access_code + * * @param string $should_redact_access_code + * * @return $this */ public function setShouldRedactAccessCode($should_redact_access_code) @@ -703,6 +848,7 @@ public function setShouldRedactAccessCode($should_redact_access_code) /** * Gets should_redact_access_code_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getShouldRedactAccessCodeMetadata() @@ -712,7 +858,9 @@ public function getShouldRedactAccessCodeMetadata() /** * Sets should_redact_access_code_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $should_redact_access_code_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $should_redact_access_code_metadata should_redact_access_code_metadata + * * @return $this */ public function setShouldRedactAccessCodeMetadata($should_redact_access_code_metadata) @@ -724,6 +872,7 @@ public function setShouldRedactAccessCodeMetadata($should_redact_access_code_met /** * Gets upload_new_image_to_sign_or_initial + * * @return string */ public function getUploadNewImageToSignOrInitial() @@ -733,7 +882,9 @@ public function getUploadNewImageToSignOrInitial() /** * Sets upload_new_image_to_sign_or_initial + * * @param string $upload_new_image_to_sign_or_initial + * * @return $this */ public function setUploadNewImageToSignOrInitial($upload_new_image_to_sign_or_initial) @@ -745,6 +896,7 @@ public function setUploadNewImageToSignOrInitial($upload_new_image_to_sign_or_in /** * Gets upload_new_image_to_sign_or_initial_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUploadNewImageToSignOrInitialMetadata() @@ -754,7 +906,9 @@ public function getUploadNewImageToSignOrInitialMetadata() /** * Sets upload_new_image_to_sign_or_initial_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $upload_new_image_to_sign_or_initial_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $upload_new_image_to_sign_or_initial_metadata upload_new_image_to_sign_or_initial_metadata + * * @return $this */ public function setUploadNewImageToSignOrInitialMetadata($upload_new_image_to_sign_or_initial_metadata) @@ -765,7 +919,9 @@ public function setUploadNewImageToSignOrInitialMetadata($upload_new_image_to_si } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -775,7 +931,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -785,8 +943,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -800,7 +960,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -810,16 +972,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AddOn.php b/src/Model/AddOn.php index 592da154..3d392099 100644 --- a/src/Model/AddOn.php +++ b/src/Model/AddOn.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AddOn Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AddOn implements ArrayAccess +class AddOn implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'addOn'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,42 @@ class AddOn implements ArrayAccess 'name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'active' => null, + 'add_on_id' => null, + 'id' => null, + 'name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -77,9 +109,9 @@ public static function swaggerTypes() 'name' => 'name' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -89,9 +121,9 @@ public static function swaggerTypes() 'name' => 'setName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -101,34 +133,63 @@ public static function swaggerTypes() 'name' => 'getName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -139,30 +200,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets active + * * @return string */ public function getActive() @@ -172,7 +235,9 @@ public function getActive() /** * Sets active + * * @param string $active Reserved: + * * @return $this */ public function setActive($active) @@ -184,6 +249,7 @@ public function setActive($active) /** * Gets add_on_id + * * @return string */ public function getAddOnId() @@ -193,7 +259,9 @@ public function getAddOnId() /** * Sets add_on_id + * * @param string $add_on_id Reserved: + * * @return $this */ public function setAddOnId($add_on_id) @@ -205,6 +273,7 @@ public function setAddOnId($add_on_id) /** * Gets id + * * @return string */ public function getId() @@ -214,7 +283,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -226,6 +297,7 @@ public function setId($id) /** * Gets name + * * @return string */ public function getName() @@ -235,7 +307,9 @@ public function getName() /** * Sets name + * * @param string $name Reserved: + * * @return $this */ public function setName($name) @@ -246,7 +320,9 @@ public function setName($name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -256,7 +332,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -266,8 +344,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -281,7 +361,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -291,16 +373,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AddressInformation.php b/src/Model/AddressInformation.php index e6c0b407..dd7a9381 100644 --- a/src/Model/AddressInformation.php +++ b/src/Model/AddressInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AddressInformation Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AddressInformation implements ArrayAccess +class AddressInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'addressInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,16 +65,51 @@ class AddressInformation implements ArrayAccess 'fax' => 'string', 'phone' => 'string', 'postal_code' => 'string', - 'state_or_province' => 'string' + 'state_or_province' => 'string', + 'zip_plus4' => 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address1' => null, + 'address2' => null, + 'city' => null, + 'country' => null, + 'fax' => null, + 'phone' => null, + 'postal_code' => null, + 'state_or_province' => null, + 'zip_plus4' => null ]; + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,12 +120,13 @@ public static function swaggerTypes() 'fax' => 'fax', 'phone' => 'phone', 'postal_code' => 'postalCode', - 'state_or_province' => 'stateOrProvince' + 'state_or_province' => 'stateOrProvince', + 'zip_plus4' => 'zipPlus4' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -98,12 +137,13 @@ public static function swaggerTypes() 'fax' => 'setFax', 'phone' => 'setPhone', 'postal_code' => 'setPostalCode', - 'state_or_province' => 'setStateOrProvince' + 'state_or_province' => 'setStateOrProvince', + 'zip_plus4' => 'setZipPlus4' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -114,37 +154,67 @@ public static function swaggerTypes() 'fax' => 'getFax', 'phone' => 'getPhone', 'postal_code' => 'getPostalCode', - 'state_or_province' => 'getStateOrProvince' + 'state_or_province' => 'getStateOrProvince', + 'zip_plus4' => 'getZipPlus4' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -156,33 +226,36 @@ public function __construct(array $data = null) $this->container['phone'] = isset($data['phone']) ? $data['phone'] : null; $this->container['postal_code'] = isset($data['postal_code']) ? $data['postal_code'] : null; $this->container['state_or_province'] = isset($data['state_or_province']) ? $data['state_or_province'] : null; + $this->container['zip_plus4'] = isset($data['zip_plus4']) ? $data['zip_plus4'] : null; } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address1 + * * @return string */ public function getAddress1() @@ -192,7 +265,9 @@ public function getAddress1() /** * Sets address1 + * * @param string $address1 First Line of the address. Maximum length: 100 characters. + * * @return $this */ public function setAddress1($address1) @@ -204,6 +279,7 @@ public function setAddress1($address1) /** * Gets address2 + * * @return string */ public function getAddress2() @@ -213,7 +289,9 @@ public function getAddress2() /** * Sets address2 + * * @param string $address2 Second Line of the address. Maximum length: 100 characters. + * * @return $this */ public function setAddress2($address2) @@ -225,6 +303,7 @@ public function setAddress2($address2) /** * Gets city + * * @return string */ public function getCity() @@ -234,7 +313,9 @@ public function getCity() /** * Sets city + * * @param string $city The city associated with the address. + * * @return $this */ public function setCity($city) @@ -246,6 +327,7 @@ public function setCity($city) /** * Gets country + * * @return string */ public function getCountry() @@ -255,7 +337,9 @@ public function getCountry() /** * Sets country + * * @param string $country Specifies the country associated with the address. + * * @return $this */ public function setCountry($country) @@ -267,6 +351,7 @@ public function setCountry($country) /** * Gets fax + * * @return string */ public function getFax() @@ -276,7 +361,9 @@ public function getFax() /** * Sets fax + * * @param string $fax A Fax number associated with the address if one is available. + * * @return $this */ public function setFax($fax) @@ -288,6 +375,7 @@ public function setFax($fax) /** * Gets phone + * * @return string */ public function getPhone() @@ -297,7 +385,9 @@ public function getPhone() /** * Sets phone + * * @param string $phone A phone number associated with the address. + * * @return $this */ public function setPhone($phone) @@ -309,6 +399,7 @@ public function setPhone($phone) /** * Gets postal_code + * * @return string */ public function getPostalCode() @@ -318,7 +409,9 @@ public function getPostalCode() /** * Sets postal_code + * * @param string $postal_code + * * @return $this */ public function setPostalCode($postal_code) @@ -330,6 +423,7 @@ public function setPostalCode($postal_code) /** * Gets state_or_province + * * @return string */ public function getStateOrProvince() @@ -339,7 +433,9 @@ public function getStateOrProvince() /** * Sets state_or_province + * * @param string $state_or_province + * * @return $this */ public function setStateOrProvince($state_or_province) @@ -348,9 +444,35 @@ public function setStateOrProvince($state_or_province) return $this; } + + /** + * Gets zip_plus4 + * + * @return string + */ + public function getZipPlus4() + { + return $this->container['zip_plus4']; + } + + /** + * Sets zip_plus4 + * + * @param string $zip_plus4 + * + * @return $this + */ + public function setZipPlus4($zip_plus4) + { + $this->container['zip_plus4'] = $zip_plus4; + + return $this; + } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -360,7 +482,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -370,8 +494,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -385,7 +511,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -395,16 +523,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AddressInformationInput.php b/src/Model/AddressInformationInput.php index 586e3e77..6ef3204e 100644 --- a/src/Model/AddressInformationInput.php +++ b/src/Model/AddressInformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AddressInformationInput Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AddressInformationInput implements ArrayAccess +class AddressInformationInput implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'addressInformationInput'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class AddressInformationInput implements ArrayAccess 'receive_in_response' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address_information' => null, + 'display_level_code' => null, + 'receive_in_response' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'receive_in_response' => 'receiveInResponse' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'receive_in_response' => 'setReceiveInResponse' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'receive_in_response' => 'getReceiveInResponse' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address_information + * * @return \DocuSign\eSign\Model\AddressInformation */ public function getAddressInformation() @@ -167,7 +229,9 @@ public function getAddressInformation() /** * Sets address_information - * @param \DocuSign\eSign\Model\AddressInformation $address_information + * + * @param \DocuSign\eSign\Model\AddressInformation $address_information address_information + * * @return $this */ public function setAddressInformation($address_information) @@ -179,6 +243,7 @@ public function setAddressInformation($address_information) /** * Gets display_level_code + * * @return string */ public function getDisplayLevelCode() @@ -188,7 +253,9 @@ public function getDisplayLevelCode() /** * Sets display_level_code + * * @param string $display_level_code Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay + * * @return $this */ public function setDisplayLevelCode($display_level_code) @@ -200,6 +267,7 @@ public function setDisplayLevelCode($display_level_code) /** * Gets receive_in_response + * * @return string */ public function getReceiveInResponse() @@ -209,7 +277,9 @@ public function getReceiveInResponse() /** * Sets receive_in_response + * * @param string $receive_in_response When set to **true**, the information needs to be returned in the response. + * * @return $this */ public function setReceiveInResponse($receive_in_response) @@ -220,7 +290,9 @@ public function setReceiveInResponse($receive_in_response) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AdminMessage.php b/src/Model/AdminMessage.php index 392e4c11..32f7c5b3 100644 --- a/src/Model/AdminMessage.php +++ b/src/Model/AdminMessage.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AdminMessage Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AdminMessage implements ArrayAccess +class AdminMessage implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'adminMessage'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class AdminMessage implements ArrayAccess 'more_information' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'base_message' => null, + 'more_information' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'more_information' => 'moreInformation' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'more_information' => 'setMoreInformation' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'more_information' => 'getMoreInformation' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets base_message + * * @return string */ public function getBaseMessage() @@ -161,7 +222,9 @@ public function getBaseMessage() /** * Sets base_message + * * @param string $base_message + * * @return $this */ public function setBaseMessage($base_message) @@ -173,6 +236,7 @@ public function setBaseMessage($base_message) /** * Gets more_information + * * @return string */ public function getMoreInformation() @@ -182,7 +246,9 @@ public function getMoreInformation() /** * Sets more_information + * * @param string $more_information + * * @return $this */ public function setMoreInformation($more_information) @@ -193,7 +259,9 @@ public function setMoreInformation($more_information) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Agent.php b/src/Model/Agent.php index ecf63d9a..a85e4f0b 100644 --- a/src/Model/Agent.php +++ b/src/Model/Agent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Agent Class Doc Comment @@ -40,24 +41,28 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Agent implements ArrayAccess +class Agent implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'agent'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'access_code' => 'string', 'access_code_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'add_access_code_to_email' => 'string', + 'additional_notifications' => '\DocuSign\eSign\Model\RecipientAdditionalNotification[]', + 'additional_notifications_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'allow_system_override_for_locked_recipient' => 'string', 'client_user_id' => 'string', 'completed_count' => 'string', @@ -85,6 +90,7 @@ class Agent implements ArrayAccess 'id_check_configuration_name' => 'string', 'id_check_configuration_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'last_name' => 'string', 'last_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', @@ -124,19 +130,116 @@ class Agent implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'additional_notifications' => null, + 'additional_notifications_metadata' => null, + 'allow_system_override_for_locked_recipient' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email' => null, + 'email_metadata' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'first_name' => null, + 'first_name_metadata' => null, + 'full_name' => null, + 'full_name_metadata' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'last_name_metadata' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'name_metadata' => null, + 'note' => null, + 'note_metadata' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_id_metadata' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'access_code' => 'accessCode', 'access_code_metadata' => 'accessCodeMetadata', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'additional_notifications' => 'additionalNotifications', + 'additional_notifications_metadata' => 'additionalNotificationsMetadata', 'allow_system_override_for_locked_recipient' => 'allowSystemOverrideForLockedRecipient', 'client_user_id' => 'clientUserId', 'completed_count' => 'completedCount', @@ -164,6 +267,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_configuration_name_metadata' => 'idCheckConfigurationNameMetadata', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'last_name' => 'lastName', 'last_name_metadata' => 'lastNameMetadata', @@ -203,15 +307,17 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'access_code' => 'setAccessCode', 'access_code_metadata' => 'setAccessCodeMetadata', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'additional_notifications' => 'setAdditionalNotifications', + 'additional_notifications_metadata' => 'setAdditionalNotificationsMetadata', 'allow_system_override_for_locked_recipient' => 'setAllowSystemOverrideForLockedRecipient', 'client_user_id' => 'setClientUserId', 'completed_count' => 'setCompletedCount', @@ -239,6 +345,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'setIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'last_name' => 'setLastName', 'last_name_metadata' => 'setLastNameMetadata', @@ -278,15 +385,17 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'access_code' => 'getAccessCode', 'access_code_metadata' => 'getAccessCodeMetadata', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'additional_notifications' => 'getAdditionalNotifications', + 'additional_notifications_metadata' => 'getAdditionalNotificationsMetadata', 'allow_system_override_for_locked_recipient' => 'getAllowSystemOverrideForLockedRecipient', 'client_user_id' => 'getClientUserId', 'completed_count' => 'getCompletedCount', @@ -314,6 +423,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'getIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'last_name' => 'getLastName', 'last_name_metadata' => 'getLastNameMetadata', @@ -353,40 +463,71 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @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['access_code_metadata'] = isset($data['access_code_metadata']) ? $data['access_code_metadata'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['additional_notifications'] = isset($data['additional_notifications']) ? $data['additional_notifications'] : null; + $this->container['additional_notifications_metadata'] = isset($data['additional_notifications_metadata']) ? $data['additional_notifications_metadata'] : null; $this->container['allow_system_override_for_locked_recipient'] = isset($data['allow_system_override_for_locked_recipient']) ? $data['allow_system_override_for_locked_recipient'] : null; $this->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; $this->container['completed_count'] = isset($data['completed_count']) ? $data['completed_count'] : null; @@ -414,6 +555,7 @@ public function __construct(array $data = null) $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_configuration_name_metadata'] = isset($data['id_check_configuration_name_metadata']) ? $data['id_check_configuration_name_metadata'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['identity_verification'] = isset($data['identity_verification']) ? $data['identity_verification'] : 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['last_name_metadata'] = isset($data['last_name_metadata']) ? $data['last_name_metadata'] : null; @@ -454,30 +596,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -487,7 +631,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -499,6 +645,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -508,7 +655,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -520,6 +669,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -529,7 +679,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -539,8 +691,57 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets additional_notifications + * + * @return \DocuSign\eSign\Model\RecipientAdditionalNotification[] + */ + public function getAdditionalNotifications() + { + return $this->container['additional_notifications']; + } + + /** + * Sets additional_notifications + * + * @param \DocuSign\eSign\Model\RecipientAdditionalNotification[] $additional_notifications + * + * @return $this + */ + public function setAdditionalNotifications($additional_notifications) + { + $this->container['additional_notifications'] = $additional_notifications; + + return $this; + } + + /** + * Gets additional_notifications_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getAdditionalNotificationsMetadata() + { + return $this->container['additional_notifications_metadata']; + } + + /** + * Sets additional_notifications_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $additional_notifications_metadata additional_notifications_metadata + * + * @return $this + */ + public function setAdditionalNotificationsMetadata($additional_notifications_metadata) + { + $this->container['additional_notifications_metadata'] = $additional_notifications_metadata; + + return $this; + } + /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -550,7 +751,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -562,6 +765,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -571,7 +775,9 @@ public function getClientUserId() /** * 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) @@ -583,6 +789,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -592,7 +799,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -604,6 +813,7 @@ public function setCompletedCount($completed_count) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -613,7 +823,9 @@ public function getCustomFields() /** * 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) @@ -625,6 +837,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -634,7 +847,9 @@ public function getDeclinedDateTime() /** * 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) @@ -646,6 +861,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -655,7 +871,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -667,6 +885,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -676,7 +895,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -688,6 +909,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -697,7 +919,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -709,6 +933,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -718,7 +943,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -730,6 +957,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -739,7 +967,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -751,6 +981,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -760,7 +991,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -772,6 +1005,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -781,7 +1015,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -793,6 +1029,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -802,7 +1039,9 @@ public function getEmail() /** * Sets email + * * @param string $email Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. + * * @return $this */ public function setEmail($email) @@ -814,6 +1053,7 @@ public function setEmail($email) /** * Gets email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailMetadata() @@ -823,7 +1063,9 @@ public function getEmailMetadata() /** * Sets email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata email_metadata + * * @return $this */ public function setEmailMetadata($email_metadata) @@ -835,6 +1077,7 @@ public function setEmailMetadata($email_metadata) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -844,7 +1087,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -856,6 +1101,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -865,7 +1111,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -877,6 +1125,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -886,7 +1135,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -898,6 +1149,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -907,7 +1159,9 @@ public function getExcludedDocuments() /** * 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) @@ -919,6 +1173,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -928,7 +1183,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -940,6 +1197,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -949,7 +1207,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -961,6 +1221,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -970,7 +1231,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -982,6 +1245,7 @@ public function setFirstName($first_name) /** * Gets first_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFirstNameMetadata() @@ -991,7 +1255,9 @@ public function getFirstNameMetadata() /** * Sets first_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata first_name_metadata + * * @return $this */ public function setFirstNameMetadata($first_name_metadata) @@ -1003,6 +1269,7 @@ public function setFirstNameMetadata($first_name_metadata) /** * Gets full_name + * * @return string */ public function getFullName() @@ -1012,7 +1279,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -1024,6 +1293,7 @@ public function setFullName($full_name) /** * Gets full_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFullNameMetadata() @@ -1033,7 +1303,9 @@ public function getFullNameMetadata() /** * Sets full_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata full_name_metadata + * * @return $this */ public function setFullNameMetadata($full_name_metadata) @@ -1045,6 +1317,7 @@ public function setFullNameMetadata($full_name_metadata) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -1054,7 +1327,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -1066,6 +1341,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -1075,7 +1351,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -1087,6 +1365,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1096,7 +1375,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -1106,8 +1387,33 @@ public function setIdCheckInformationInput($id_check_information_input) return $this; } + /** + * Gets identity_verification + * + * @return \DocuSign\eSign\Model\RecipientIdentityVerification + */ + public function getIdentityVerification() + { + return $this->container['identity_verification']; + } + + /** + * Sets identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * + * @return $this + */ + public function setIdentityVerification($identity_verification) + { + $this->container['identity_verification'] = $identity_verification; + + return $this; + } + /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1117,7 +1423,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -1129,6 +1437,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -1138,7 +1447,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -1150,6 +1461,7 @@ public function setLastName($last_name) /** * Gets last_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLastNameMetadata() @@ -1159,7 +1471,9 @@ public function getLastNameMetadata() /** * Sets last_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata last_name_metadata + * * @return $this */ public function setLastNameMetadata($last_name_metadata) @@ -1171,6 +1485,7 @@ public function setLastNameMetadata($last_name_metadata) /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -1180,7 +1495,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -1192,6 +1509,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -1201,7 +1519,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -1213,6 +1533,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -1222,7 +1543,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1234,6 +1557,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1243,7 +1567,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1255,6 +1581,7 @@ public function setNameMetadata($name_metadata) /** * Gets note + * * @return string */ public function getNote() @@ -1264,7 +1591,9 @@ public function getNote() /** * 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) @@ -1276,6 +1605,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1285,7 +1615,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1297,6 +1629,7 @@ public function setNoteMetadata($note_metadata) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1306,7 +1639,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1318,6 +1653,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1327,7 +1663,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1339,6 +1677,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1348,7 +1687,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1360,6 +1701,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1369,7 +1711,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1381,6 +1725,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1390,7 +1735,9 @@ public function getRecipientId() /** * 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) @@ -1402,6 +1749,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1411,7 +1759,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1423,6 +1773,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1432,7 +1783,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1444,6 +1797,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1453,7 +1807,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1465,6 +1821,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1474,7 +1831,9 @@ public function getRequireIdLookup() /** * 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) @@ -1486,6 +1845,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1495,7 +1855,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1507,6 +1869,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1516,7 +1879,9 @@ public function getRoleName() /** * 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) @@ -1528,6 +1893,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1537,7 +1903,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -1549,6 +1917,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -1558,7 +1927,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -1570,6 +1941,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1579,7 +1951,9 @@ public function getSentDateTime() /** * 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) @@ -1591,6 +1965,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1600,7 +1975,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -1612,6 +1989,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1621,7 +1999,9 @@ public function getSigningGroupId() /** * 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) @@ -1633,6 +2013,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSigningGroupIdMetadata() @@ -1642,7 +2023,9 @@ public function getSigningGroupIdMetadata() /** * Sets signing_group_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata signing_group_id_metadata + * * @return $this */ public function setSigningGroupIdMetadata($signing_group_id_metadata) @@ -1654,6 +2037,7 @@ public function setSigningGroupIdMetadata($signing_group_id_metadata) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1663,7 +2047,9 @@ public function getSigningGroupName() /** * 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) @@ -1675,6 +2061,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1684,7 +2071,9 @@ public function getSigningGroupUsers() /** * 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) @@ -1696,6 +2085,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1705,7 +2095,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -1717,6 +2109,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1726,7 +2119,9 @@ public function getSocialAuthentications() /** * 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) @@ -1738,6 +2133,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1747,7 +2143,9 @@ public function getStatus() /** * 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) @@ -1759,6 +2157,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -1768,7 +2167,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -1780,6 +2181,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -1789,7 +2191,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -1801,6 +2205,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1810,7 +2215,9 @@ public function getTemplateLocked() /** * 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) @@ -1822,6 +2229,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1831,7 +2239,9 @@ public function getTemplateRequired() /** * 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) @@ -1843,6 +2253,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1852,7 +2263,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1864,6 +2277,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1873,7 +2287,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1884,7 +2300,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1894,7 +2312,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1904,8 +2324,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1919,7 +2341,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1929,16 +2353,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ApiRequestLog.php b/src/Model/ApiRequestLog.php index 320bc50b..69cc4abb 100644 --- a/src/Model/ApiRequestLog.php +++ b/src/Model/ApiRequestLog.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ApiRequestLog Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ApiRequestLog implements ArrayAccess +class ApiRequestLog implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'apiRequestLog'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,42 @@ class ApiRequestLog implements ArrayAccess 'status' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'created_date_time' => null, + 'description' => null, + 'request_log_id' => null, + 'status' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -77,9 +109,9 @@ public static function swaggerTypes() 'status' => 'status' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -89,9 +121,9 @@ public static function swaggerTypes() 'status' => 'setStatus' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -101,34 +133,63 @@ public static function swaggerTypes() 'status' => 'getStatus' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -139,30 +200,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -172,7 +235,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -184,6 +249,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets description + * * @return string */ public function getDescription() @@ -193,7 +259,9 @@ public function getDescription() /** * Sets description + * * @param string $description + * * @return $this */ public function setDescription($description) @@ -205,6 +273,7 @@ public function setDescription($description) /** * Gets request_log_id + * * @return string */ public function getRequestLogId() @@ -214,7 +283,9 @@ public function getRequestLogId() /** * Sets request_log_id + * * @param string $request_log_id + * * @return $this */ public function setRequestLogId($request_log_id) @@ -226,6 +297,7 @@ public function setRequestLogId($request_log_id) /** * Gets status + * * @return string */ public function getStatus() @@ -235,7 +307,9 @@ public function getStatus() /** * 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) @@ -246,7 +320,9 @@ public function setStatus($status) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -256,7 +332,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -266,8 +344,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -281,7 +361,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -291,16 +373,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ApiRequestLogsResult.php b/src/Model/ApiRequestLogsResult.php index 9d1ea8d5..721f1ab4 100644 --- a/src/Model/ApiRequestLogsResult.php +++ b/src/Model/ApiRequestLogsResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ApiRequestLogsResult Class Doc Comment @@ -40,83 +41,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ApiRequestLogsResult implements ArrayAccess +class ApiRequestLogsResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'apiRequestLogsResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'api_request_logs' => '\DocuSign\eSign\Model\ApiRequestLog[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'api_request_logs' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'api_request_logs' => 'apiRequestLogs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'api_request_logs' => 'setApiRequestLogs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'api_request_logs' => 'getApiRequestLogs' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -124,30 +182,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets api_request_logs + * * @return \DocuSign\eSign\Model\ApiRequestLog[] */ public function getApiRequestLogs() @@ -157,7 +217,9 @@ public function getApiRequestLogs() /** * Sets api_request_logs + * * @param \DocuSign\eSign\Model\ApiRequestLog[] $api_request_logs Reserved: TBD + * * @return $this */ public function setApiRequestLogs($api_request_logs) @@ -168,7 +230,9 @@ public function setApiRequestLogs($api_request_logs) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -178,7 +242,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -188,8 +254,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -203,7 +271,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -213,16 +283,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AppStoreProduct.php b/src/Model/AppStoreProduct.php index 8f8b4c59..be2b9c10 100644 --- a/src/Model/AppStoreProduct.php +++ b/src/Model/AppStoreProduct.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AppStoreProduct Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AppStoreProduct implements ArrayAccess +class AppStoreProduct implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'appStoreProduct'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,40 @@ class AppStoreProduct implements ArrayAccess 'product_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'market_place' => null, + 'product_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -73,9 +103,9 @@ public static function swaggerTypes() 'product_id' => 'productId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -83,9 +113,9 @@ public static function swaggerTypes() 'product_id' => 'setProductId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -93,34 +123,63 @@ public static function swaggerTypes() 'product_id' => 'getProductId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -129,30 +188,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets market_place + * * @return string */ public function getMarketPlace() @@ -162,7 +223,9 @@ public function getMarketPlace() /** * Sets market_place + * * @param string $market_place + * * @return $this */ public function setMarketPlace($market_place) @@ -174,6 +237,7 @@ public function setMarketPlace($market_place) /** * Gets product_id + * * @return string */ public function getProductId() @@ -183,7 +247,9 @@ public function getProductId() /** * Sets product_id + * * @param string $product_id The Product ID from the AppStore. + * * @return $this */ public function setProductId($product_id) @@ -194,7 +260,9 @@ public function setProductId($product_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -204,7 +272,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -214,8 +284,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -229,7 +301,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -239,16 +313,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AppStoreReceipt.php b/src/Model/AppStoreReceipt.php index 37605a86..89ee899d 100644 --- a/src/Model/AppStoreReceipt.php +++ b/src/Model/AppStoreReceipt.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AppStoreReceipt Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AppStoreReceipt implements ArrayAccess +class AppStoreReceipt implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'appStoreReceipt'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,40 @@ class AppStoreReceipt implements ArrayAccess 'receipt_data' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'product_id' => null, + 'receipt_data' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -73,9 +103,9 @@ public static function swaggerTypes() 'receipt_data' => 'receiptData' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -83,9 +113,9 @@ public static function swaggerTypes() 'receipt_data' => 'setReceiptData' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -93,34 +123,63 @@ public static function swaggerTypes() 'receipt_data' => 'getReceiptData' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -129,30 +188,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets product_id + * * @return string */ public function getProductId() @@ -162,7 +223,9 @@ public function getProductId() /** * Sets product_id + * * @param string $product_id + * * @return $this */ public function setProductId($product_id) @@ -174,6 +237,7 @@ public function setProductId($product_id) /** * Gets receipt_data + * * @return string */ public function getReceiptData() @@ -183,7 +247,9 @@ public function getReceiptData() /** * Sets receipt_data + * * @param string $receipt_data Reserved: TBD + * * @return $this */ public function setReceiptData($receipt_data) @@ -194,7 +260,9 @@ public function setReceiptData($receipt_data) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -204,7 +272,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -214,8 +284,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -229,7 +301,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -239,16 +313,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Approve.php b/src/Model/Approve.php index efccd76c..5cae282e 100644 --- a/src/Model/Approve.php +++ b/src/Model/Approve.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Approve Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Approve implements ArrayAccess +class Approve implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'approve'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -141,13 +144,123 @@ class Approve implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'button_text' => null, + 'button_text_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -238,9 +351,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -331,9 +444,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -424,34 +537,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -543,30 +685,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -576,7 +720,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -588,6 +734,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -597,7 +744,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -609,6 +758,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -618,7 +768,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -630,6 +782,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -639,7 +792,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -651,6 +806,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -660,7 +816,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -672,6 +830,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -681,7 +840,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -693,6 +854,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -702,7 +864,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -714,6 +878,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -723,7 +888,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -735,6 +902,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -744,7 +912,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -756,6 +926,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -765,7 +936,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -777,6 +950,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -786,7 +960,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -798,6 +974,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -807,7 +984,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -819,6 +998,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -828,7 +1008,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -840,6 +1022,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -849,7 +1032,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -861,6 +1046,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -870,7 +1056,9 @@ public function getAnchorUnits() /** * 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) @@ -882,6 +1070,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -891,7 +1080,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -903,6 +1094,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -912,7 +1104,9 @@ public function getAnchorXOffset() /** * 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) @@ -924,6 +1118,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -933,7 +1128,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -945,6 +1142,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -954,7 +1152,9 @@ public function getAnchorYOffset() /** * 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) @@ -966,6 +1166,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -975,7 +1176,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -987,6 +1190,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -996,7 +1200,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1008,6 +1214,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1017,7 +1224,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1029,6 +1238,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets button_text + * * @return string */ public function getButtonText() @@ -1038,7 +1248,9 @@ public function getButtonText() /** * Sets button_text + * * @param string $button_text Specifies the approval text displayed in the tab. + * * @return $this */ public function setButtonText($button_text) @@ -1050,6 +1262,7 @@ public function setButtonText($button_text) /** * Gets button_text_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getButtonTextMetadata() @@ -1059,7 +1272,9 @@ public function getButtonTextMetadata() /** * Sets button_text_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $button_text_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $button_text_metadata button_text_metadata + * * @return $this */ public function setButtonTextMetadata($button_text_metadata) @@ -1071,6 +1286,7 @@ public function setButtonTextMetadata($button_text_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1080,7 +1296,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1092,6 +1310,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1101,7 +1320,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1113,6 +1334,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1122,7 +1344,9 @@ public function getConditionalParentValue() /** * 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) @@ -1134,6 +1358,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1143,7 +1368,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1155,6 +1382,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1164,7 +1392,9 @@ public function getCustomTabId() /** * 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) @@ -1176,6 +1406,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1185,7 +1416,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1197,6 +1430,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1206,7 +1440,9 @@ public function getDocumentId() /** * 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) @@ -1218,6 +1454,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1227,7 +1464,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1239,6 +1478,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1248,7 +1488,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1260,6 +1502,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1269,7 +1512,9 @@ public function getFont() /** * 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) @@ -1281,6 +1526,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1290,7 +1536,9 @@ public function getFontColor() /** * 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) @@ -1302,6 +1550,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1311,7 +1560,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1323,6 +1574,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1332,7 +1584,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1344,6 +1598,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1353,7 +1608,9 @@ public function getFontSize() /** * 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) @@ -1365,6 +1622,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1374,7 +1632,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1386,6 +1646,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1395,7 +1656,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1407,6 +1670,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1416,7 +1680,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1428,6 +1694,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1437,7 +1704,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1449,6 +1718,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1458,7 +1728,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1470,6 +1742,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1479,7 +1752,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1491,6 +1766,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1500,7 +1776,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1512,6 +1790,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1521,7 +1800,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1533,6 +1814,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1542,7 +1824,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1554,6 +1838,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1563,7 +1848,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1575,6 +1862,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1584,7 +1872,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1596,6 +1886,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1605,7 +1896,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1617,6 +1910,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1626,7 +1920,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1638,6 +1934,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1647,7 +1944,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1659,6 +1958,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1668,7 +1968,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1680,6 +1982,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1689,7 +1992,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1701,6 +2006,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1710,7 +2016,9 @@ public function getRecipientId() /** * 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) @@ -1722,6 +2030,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1731,7 +2040,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1743,6 +2054,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1752,7 +2064,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1764,6 +2078,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1773,7 +2088,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1785,6 +2102,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1794,7 +2112,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1806,6 +2126,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1815,7 +2136,9 @@ public function getStatus() /** * 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) @@ -1827,6 +2150,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1836,7 +2160,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1848,6 +2174,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1857,7 +2184,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1869,6 +2198,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1878,7 +2208,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1890,6 +2222,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1899,7 +2232,9 @@ public function getTabId() /** * 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) @@ -1911,6 +2246,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1920,7 +2256,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1932,6 +2270,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1941,7 +2280,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1953,6 +2294,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1962,7 +2304,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1974,6 +2318,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1983,7 +2328,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1995,6 +2342,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2004,7 +2352,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2016,6 +2366,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2025,7 +2376,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2037,6 +2390,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2046,7 +2400,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2058,6 +2414,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2067,7 +2424,9 @@ public function getTemplateLocked() /** * 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) @@ -2079,6 +2438,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2088,7 +2448,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2100,6 +2462,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2109,7 +2472,9 @@ public function getTemplateRequired() /** * 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) @@ -2121,6 +2486,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2130,7 +2496,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2142,6 +2510,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2151,7 +2520,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2163,6 +2534,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2172,7 +2544,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2184,6 +2558,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2193,7 +2568,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2205,6 +2582,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2214,7 +2592,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2226,6 +2606,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2235,7 +2616,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2247,6 +2630,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2256,7 +2640,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2268,6 +2654,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2277,7 +2664,9 @@ public function getXPosition() /** * 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) @@ -2289,6 +2678,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2298,7 +2688,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2310,6 +2702,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2319,7 +2712,9 @@ public function getYPosition() /** * 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) @@ -2331,6 +2726,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2340,7 +2736,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2351,7 +2749,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2361,7 +2761,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2371,8 +2773,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2386,7 +2790,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2396,16 +2802,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AskAnAdmin.php b/src/Model/AskAnAdmin.php index 2f503ccb..8209d50b 100644 --- a/src/Model/AskAnAdmin.php +++ b/src/Model/AskAnAdmin.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AskAnAdmin Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AskAnAdmin implements ArrayAccess +class AskAnAdmin implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'askAnAdmin'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class AskAnAdmin implements ArrayAccess 'phone' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'email' => null, + 'message' => null, + 'name' => null, + 'phone' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'phone' => 'phone' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'phone' => 'setPhone' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'phone' => 'getPhone' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets email + * * @return string */ public function getEmail() @@ -171,7 +234,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -183,6 +248,7 @@ public function setEmail($email) /** * Gets message + * * @return string */ public function getMessage() @@ -192,7 +258,9 @@ public function getMessage() /** * Sets message + * * @param string $message + * * @return $this */ public function setMessage($message) @@ -204,6 +272,7 @@ public function setMessage($message) /** * Gets name + * * @return string */ public function getName() @@ -213,7 +282,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -225,6 +296,7 @@ public function setName($name) /** * Gets phone + * * @return string */ public function getPhone() @@ -234,7 +306,9 @@ public function getPhone() /** * Sets phone + * * @param string $phone + * * @return $this */ public function setPhone($phone) @@ -245,7 +319,9 @@ public function setPhone($phone) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Attachment.php b/src/Model/Attachment.php index 7655a75f..db8bda16 100644 --- a/src/Model/Attachment.php +++ b/src/Model/Attachment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Attachment Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Attachment implements ArrayAccess +class Attachment implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'attachment'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,45 @@ class Attachment implements ArrayAccess 'remote_url' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_control' => null, + 'attachment_id' => null, + 'attachment_type' => null, + 'data' => null, + 'label' => null, + 'name' => null, + 'remote_url' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -83,9 +118,9 @@ public static function swaggerTypes() 'remote_url' => 'remoteUrl' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -98,9 +133,9 @@ public static function swaggerTypes() 'remote_url' => 'setRemoteUrl' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -113,34 +148,63 @@ public static function swaggerTypes() 'remote_url' => 'getRemoteUrl' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -154,30 +218,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_control + * * @return string */ public function getAccessControl() @@ -187,7 +253,9 @@ public function getAccessControl() /** * Sets access_control + * * @param string $access_control + * * @return $this */ public function setAccessControl($access_control) @@ -199,6 +267,7 @@ public function setAccessControl($access_control) /** * Gets attachment_id + * * @return string */ public function getAttachmentId() @@ -208,7 +277,9 @@ public function getAttachmentId() /** * Sets attachment_id + * * @param string $attachment_id + * * @return $this */ public function setAttachmentId($attachment_id) @@ -220,6 +291,7 @@ public function setAttachmentId($attachment_id) /** * Gets attachment_type + * * @return string */ public function getAttachmentType() @@ -229,7 +301,9 @@ public function getAttachmentType() /** * Sets attachment_type + * * @param string $attachment_type Specifies the type of the attachment for the recipient. + * * @return $this */ public function setAttachmentType($attachment_type) @@ -241,6 +315,7 @@ public function setAttachmentType($attachment_type) /** * Gets data + * * @return string */ public function getData() @@ -250,7 +325,9 @@ public function getData() /** * Sets data + * * @param string $data + * * @return $this */ public function setData($data) @@ -262,6 +339,7 @@ public function setData($data) /** * Gets label + * * @return string */ public function getLabel() @@ -271,7 +349,9 @@ public function getLabel() /** * Sets label + * * @param string $label + * * @return $this */ public function setLabel($label) @@ -283,6 +363,7 @@ public function setLabel($label) /** * Gets name + * * @return string */ public function getName() @@ -292,7 +373,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -304,6 +387,7 @@ public function setName($name) /** * Gets remote_url + * * @return string */ public function getRemoteUrl() @@ -313,7 +397,9 @@ public function getRemoteUrl() /** * Sets remote_url + * * @param string $remote_url + * * @return $this */ public function setRemoteUrl($remote_url) @@ -324,7 +410,9 @@ public function setRemoteUrl($remote_url) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -334,7 +422,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -344,8 +434,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -359,7 +451,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -369,16 +463,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AuthenticationMethod.php b/src/Model/AuthenticationMethod.php index 9dce9c8a..f263a871 100644 --- a/src/Model/AuthenticationMethod.php +++ b/src/Model/AuthenticationMethod.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AuthenticationMethod Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AuthenticationMethod implements ArrayAccess +class AuthenticationMethod implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'authenticationMethod'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,42 @@ class AuthenticationMethod implements ArrayAccess 'total_count' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'authentication_type' => null, + 'last_provider' => null, + 'last_timestamp' => null, + 'total_count' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -77,9 +109,9 @@ public static function swaggerTypes() 'total_count' => 'totalCount' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -89,9 +121,9 @@ public static function swaggerTypes() 'total_count' => 'setTotalCount' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -101,34 +133,63 @@ public static function swaggerTypes() 'total_count' => 'getTotalCount' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -139,30 +200,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets authentication_type + * * @return string */ public function getAuthenticationType() @@ -172,7 +235,9 @@ public function getAuthenticationType() /** * Sets authentication_type + * * @param string $authentication_type Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth. + * * @return $this */ public function setAuthenticationType($authentication_type) @@ -184,6 +249,7 @@ public function setAuthenticationType($authentication_type) /** * Gets last_provider + * * @return string */ public function getLastProvider() @@ -193,7 +259,9 @@ public function getLastProvider() /** * Sets last_provider + * * @param string $last_provider The last provider that authenticated the user. + * * @return $this */ public function setLastProvider($last_provider) @@ -205,6 +273,7 @@ public function setLastProvider($last_provider) /** * Gets last_timestamp + * * @return string */ public function getLastTimestamp() @@ -214,7 +283,9 @@ public function getLastTimestamp() /** * Sets last_timestamp + * * @param string $last_timestamp The data and time the user last used the authentication method. + * * @return $this */ public function setLastTimestamp($last_timestamp) @@ -226,6 +297,7 @@ public function setLastTimestamp($last_timestamp) /** * Gets total_count + * * @return string */ public function getTotalCount() @@ -235,7 +307,9 @@ public function getTotalCount() /** * Sets total_count + * * @param string $total_count The number of times the authentication method was used. + * * @return $this */ public function setTotalCount($total_count) @@ -246,7 +320,9 @@ public function setTotalCount($total_count) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -256,7 +332,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -266,8 +344,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -281,7 +361,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -291,16 +373,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/AuthenticationStatus.php b/src/Model/AuthenticationStatus.php index 02a714a6..c1e200ff 100644 --- a/src/Model/AuthenticationStatus.php +++ b/src/Model/AuthenticationStatus.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AuthenticationStatus Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AuthenticationStatus implements ArrayAccess +class AuthenticationStatus implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'authenticationStatus'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -76,13 +79,57 @@ class AuthenticationStatus implements ArrayAccess 'yahoo_result' => '\DocuSign\eSign\Model\EventResult' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code_result' => null, + 'age_verify_result' => null, + 'any_social_id_result' => null, + 'facebook_result' => null, + 'google_result' => null, + 'identity_verification_result' => null, + 'id_lookup_result' => null, + 'id_questions_result' => null, + 'linkedin_result' => null, + 'live_id_result' => null, + 'ofac_result' => null, + 'open_id_result' => null, + 'phone_auth_result' => null, + 'salesforce_result' => null, + 'signature_provider_result' => null, + 'sms_auth_result' => null, + 's_tan_pin_result' => null, + 'twitter_result' => null, + 'yahoo_result' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -107,9 +154,9 @@ public static function swaggerTypes() 'yahoo_result' => 'yahooResult' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -134,9 +181,9 @@ public static function swaggerTypes() 'yahoo_result' => 'setYahooResult' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -161,34 +208,63 @@ public static function swaggerTypes() 'yahoo_result' => 'getYahooResult' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -214,30 +290,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getAccessCodeResult() @@ -247,7 +325,9 @@ public function getAccessCodeResult() /** * Sets access_code_result - * @param \DocuSign\eSign\Model\EventResult $access_code_result + * + * @param \DocuSign\eSign\Model\EventResult $access_code_result access_code_result + * * @return $this */ public function setAccessCodeResult($access_code_result) @@ -259,6 +339,7 @@ public function setAccessCodeResult($access_code_result) /** * Gets age_verify_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getAgeVerifyResult() @@ -268,7 +349,9 @@ public function getAgeVerifyResult() /** * Sets age_verify_result - * @param \DocuSign\eSign\Model\EventResult $age_verify_result + * + * @param \DocuSign\eSign\Model\EventResult $age_verify_result age_verify_result + * * @return $this */ public function setAgeVerifyResult($age_verify_result) @@ -280,6 +363,7 @@ public function setAgeVerifyResult($age_verify_result) /** * Gets any_social_id_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getAnySocialIdResult() @@ -289,7 +373,9 @@ public function getAnySocialIdResult() /** * Sets any_social_id_result - * @param \DocuSign\eSign\Model\EventResult $any_social_id_result + * + * @param \DocuSign\eSign\Model\EventResult $any_social_id_result any_social_id_result + * * @return $this */ public function setAnySocialIdResult($any_social_id_result) @@ -301,6 +387,7 @@ public function setAnySocialIdResult($any_social_id_result) /** * Gets facebook_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getFacebookResult() @@ -310,7 +397,9 @@ public function getFacebookResult() /** * Sets facebook_result - * @param \DocuSign\eSign\Model\EventResult $facebook_result + * + * @param \DocuSign\eSign\Model\EventResult $facebook_result facebook_result + * * @return $this */ public function setFacebookResult($facebook_result) @@ -322,6 +411,7 @@ public function setFacebookResult($facebook_result) /** * Gets google_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getGoogleResult() @@ -331,7 +421,9 @@ public function getGoogleResult() /** * Sets google_result - * @param \DocuSign\eSign\Model\EventResult $google_result + * + * @param \DocuSign\eSign\Model\EventResult $google_result google_result + * * @return $this */ public function setGoogleResult($google_result) @@ -343,6 +435,7 @@ public function setGoogleResult($google_result) /** * Gets identity_verification_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getIdentityVerificationResult() @@ -352,7 +445,9 @@ public function getIdentityVerificationResult() /** * Sets identity_verification_result - * @param \DocuSign\eSign\Model\EventResult $identity_verification_result + * + * @param \DocuSign\eSign\Model\EventResult $identity_verification_result identity_verification_result + * * @return $this */ public function setIdentityVerificationResult($identity_verification_result) @@ -364,6 +459,7 @@ public function setIdentityVerificationResult($identity_verification_result) /** * Gets id_lookup_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getIdLookupResult() @@ -373,7 +469,9 @@ public function getIdLookupResult() /** * Sets id_lookup_result - * @param \DocuSign\eSign\Model\EventResult $id_lookup_result + * + * @param \DocuSign\eSign\Model\EventResult $id_lookup_result id_lookup_result + * * @return $this */ public function setIdLookupResult($id_lookup_result) @@ -385,6 +483,7 @@ public function setIdLookupResult($id_lookup_result) /** * Gets id_questions_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getIdQuestionsResult() @@ -394,7 +493,9 @@ public function getIdQuestionsResult() /** * Sets id_questions_result - * @param \DocuSign\eSign\Model\EventResult $id_questions_result + * + * @param \DocuSign\eSign\Model\EventResult $id_questions_result id_questions_result + * * @return $this */ public function setIdQuestionsResult($id_questions_result) @@ -406,6 +507,7 @@ public function setIdQuestionsResult($id_questions_result) /** * Gets linkedin_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getLinkedinResult() @@ -415,7 +517,9 @@ public function getLinkedinResult() /** * Sets linkedin_result - * @param \DocuSign\eSign\Model\EventResult $linkedin_result + * + * @param \DocuSign\eSign\Model\EventResult $linkedin_result linkedin_result + * * @return $this */ public function setLinkedinResult($linkedin_result) @@ -427,6 +531,7 @@ public function setLinkedinResult($linkedin_result) /** * Gets live_id_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getLiveIdResult() @@ -436,7 +541,9 @@ public function getLiveIdResult() /** * Sets live_id_result - * @param \DocuSign\eSign\Model\EventResult $live_id_result + * + * @param \DocuSign\eSign\Model\EventResult $live_id_result live_id_result + * * @return $this */ public function setLiveIdResult($live_id_result) @@ -448,6 +555,7 @@ public function setLiveIdResult($live_id_result) /** * Gets ofac_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getOfacResult() @@ -457,7 +565,9 @@ public function getOfacResult() /** * Sets ofac_result - * @param \DocuSign\eSign\Model\EventResult $ofac_result + * + * @param \DocuSign\eSign\Model\EventResult $ofac_result ofac_result + * * @return $this */ public function setOfacResult($ofac_result) @@ -469,6 +579,7 @@ public function setOfacResult($ofac_result) /** * Gets open_id_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getOpenIdResult() @@ -478,7 +589,9 @@ public function getOpenIdResult() /** * Sets open_id_result - * @param \DocuSign\eSign\Model\EventResult $open_id_result + * + * @param \DocuSign\eSign\Model\EventResult $open_id_result open_id_result + * * @return $this */ public function setOpenIdResult($open_id_result) @@ -490,6 +603,7 @@ public function setOpenIdResult($open_id_result) /** * Gets phone_auth_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getPhoneAuthResult() @@ -499,7 +613,9 @@ public function getPhoneAuthResult() /** * Sets phone_auth_result - * @param \DocuSign\eSign\Model\EventResult $phone_auth_result + * + * @param \DocuSign\eSign\Model\EventResult $phone_auth_result phone_auth_result + * * @return $this */ public function setPhoneAuthResult($phone_auth_result) @@ -511,6 +627,7 @@ public function setPhoneAuthResult($phone_auth_result) /** * Gets salesforce_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getSalesforceResult() @@ -520,7 +637,9 @@ public function getSalesforceResult() /** * Sets salesforce_result - * @param \DocuSign\eSign\Model\EventResult $salesforce_result + * + * @param \DocuSign\eSign\Model\EventResult $salesforce_result salesforce_result + * * @return $this */ public function setSalesforceResult($salesforce_result) @@ -532,6 +651,7 @@ public function setSalesforceResult($salesforce_result) /** * Gets signature_provider_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getSignatureProviderResult() @@ -541,7 +661,9 @@ public function getSignatureProviderResult() /** * Sets signature_provider_result - * @param \DocuSign\eSign\Model\EventResult $signature_provider_result + * + * @param \DocuSign\eSign\Model\EventResult $signature_provider_result signature_provider_result + * * @return $this */ public function setSignatureProviderResult($signature_provider_result) @@ -553,6 +675,7 @@ public function setSignatureProviderResult($signature_provider_result) /** * Gets sms_auth_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getSmsAuthResult() @@ -562,7 +685,9 @@ public function getSmsAuthResult() /** * Sets sms_auth_result - * @param \DocuSign\eSign\Model\EventResult $sms_auth_result + * + * @param \DocuSign\eSign\Model\EventResult $sms_auth_result sms_auth_result + * * @return $this */ public function setSmsAuthResult($sms_auth_result) @@ -574,6 +699,7 @@ public function setSmsAuthResult($sms_auth_result) /** * Gets s_tan_pin_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getSTanPinResult() @@ -583,7 +709,9 @@ public function getSTanPinResult() /** * Sets s_tan_pin_result - * @param \DocuSign\eSign\Model\EventResult $s_tan_pin_result + * + * @param \DocuSign\eSign\Model\EventResult $s_tan_pin_result s_tan_pin_result + * * @return $this */ public function setSTanPinResult($s_tan_pin_result) @@ -595,6 +723,7 @@ public function setSTanPinResult($s_tan_pin_result) /** * Gets twitter_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getTwitterResult() @@ -604,7 +733,9 @@ public function getTwitterResult() /** * Sets twitter_result - * @param \DocuSign\eSign\Model\EventResult $twitter_result + * + * @param \DocuSign\eSign\Model\EventResult $twitter_result twitter_result + * * @return $this */ public function setTwitterResult($twitter_result) @@ -616,6 +747,7 @@ public function setTwitterResult($twitter_result) /** * Gets yahoo_result + * * @return \DocuSign\eSign\Model\EventResult */ public function getYahooResult() @@ -625,7 +757,9 @@ public function getYahooResult() /** * Sets yahoo_result - * @param \DocuSign\eSign\Model\EventResult $yahoo_result + * + * @param \DocuSign\eSign\Model\EventResult $yahoo_result yahoo_result + * * @return $this */ public function setYahooResult($yahoo_result) @@ -636,7 +770,9 @@ public function setYahooResult($yahoo_result) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -646,7 +782,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -656,8 +794,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -671,7 +811,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -681,16 +823,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BccEmailAddress.php b/src/Model/BccEmailAddress.php index 1458ddd7..f0e2af85 100644 --- a/src/Model/BccEmailAddress.php +++ b/src/Model/BccEmailAddress.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BccEmailAddress Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BccEmailAddress implements ArrayAccess +class BccEmailAddress implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bccEmailAddress'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,40 @@ class BccEmailAddress implements ArrayAccess 'email' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bcc_email_address_id' => null, + 'email' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -73,9 +103,9 @@ public static function swaggerTypes() 'email' => 'email' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -83,9 +113,9 @@ public static function swaggerTypes() 'email' => 'setEmail' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -93,34 +123,63 @@ public static function swaggerTypes() 'email' => 'getEmail' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -129,30 +188,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bcc_email_address_id + * * @return string */ public function getBccEmailAddressId() @@ -162,7 +223,9 @@ public function getBccEmailAddressId() /** * Sets bcc_email_address_id + * * @param string $bcc_email_address_id Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email. 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. + * * @return $this */ public function setBccEmailAddressId($bcc_email_address_id) @@ -174,6 +237,7 @@ public function setBccEmailAddressId($bcc_email_address_id) /** * Gets email + * * @return string */ public function getEmail() @@ -183,7 +247,9 @@ public function getEmail() /** * Sets email + * * @param string $email Specifies the BCC email address. 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 of length: 100 characters. + * * @return $this */ public function setEmail($email) @@ -194,7 +260,9 @@ public function setEmail($email) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -204,7 +272,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -214,8 +284,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -229,7 +301,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -239,16 +313,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BccEmailArchive.php b/src/Model/BccEmailArchive.php index df47c41e..9cc93982 100644 --- a/src/Model/BccEmailArchive.php +++ b/src/Model/BccEmailArchive.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BccEmailArchive Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BccEmailArchive implements ArrayAccess +class BccEmailArchive implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bccEmailArchive'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class BccEmailArchive implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_id' => null, + 'bcc_email_archive_id' => null, + 'created' => null, + 'created_by' => null, + 'email' => null, + 'email_notification_id' => null, + 'modified' => null, + 'modified_by' => null, + 'status' => null, + 'uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'uri' => 'getUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_id + * * @return string */ public function getAccountId() @@ -201,7 +270,9 @@ public function getAccountId() /** * Sets account_id + * * @param string $account_id The account ID associated with the envelope. + * * @return $this */ public function setAccountId($account_id) @@ -213,6 +284,7 @@ public function setAccountId($account_id) /** * Gets bcc_email_archive_id + * * @return string */ public function getBccEmailArchiveId() @@ -222,7 +294,9 @@ public function getBccEmailArchiveId() /** * Sets bcc_email_archive_id + * * @param string $bcc_email_archive_id + * * @return $this */ public function setBccEmailArchiveId($bcc_email_archive_id) @@ -234,6 +308,7 @@ public function setBccEmailArchiveId($bcc_email_archive_id) /** * Gets created + * * @return string */ public function getCreated() @@ -243,7 +318,9 @@ public function getCreated() /** * Sets created + * * @param string $created + * * @return $this */ public function setCreated($created) @@ -255,6 +332,7 @@ public function setCreated($created) /** * Gets created_by + * * @return \DocuSign\eSign\Model\UserInfo */ public function getCreatedBy() @@ -264,7 +342,9 @@ public function getCreatedBy() /** * Sets created_by - * @param \DocuSign\eSign\Model\UserInfo $created_by + * + * @param \DocuSign\eSign\Model\UserInfo $created_by created_by + * * @return $this */ public function setCreatedBy($created_by) @@ -276,6 +356,7 @@ public function setCreatedBy($created_by) /** * Gets email + * * @return string */ public function getEmail() @@ -285,7 +366,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -297,6 +380,7 @@ public function setEmail($email) /** * Gets email_notification_id + * * @return string */ public function getEmailNotificationId() @@ -306,7 +390,9 @@ public function getEmailNotificationId() /** * Sets email_notification_id + * * @param string $email_notification_id + * * @return $this */ public function setEmailNotificationId($email_notification_id) @@ -318,6 +404,7 @@ public function setEmailNotificationId($email_notification_id) /** * Gets modified + * * @return string */ public function getModified() @@ -327,7 +414,9 @@ public function getModified() /** * Sets modified + * * @param string $modified + * * @return $this */ public function setModified($modified) @@ -339,6 +428,7 @@ public function setModified($modified) /** * Gets modified_by + * * @return \DocuSign\eSign\Model\UserInfo */ public function getModifiedBy() @@ -348,7 +438,9 @@ public function getModifiedBy() /** * Sets modified_by - * @param \DocuSign\eSign\Model\UserInfo $modified_by + * + * @param \DocuSign\eSign\Model\UserInfo $modified_by modified_by + * * @return $this */ public function setModifiedBy($modified_by) @@ -360,6 +452,7 @@ public function setModifiedBy($modified_by) /** * Gets status + * * @return string */ public function getStatus() @@ -369,7 +462,9 @@ public function getStatus() /** * 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) @@ -381,6 +476,7 @@ public function setStatus($status) /** * Gets uri + * * @return string */ public function getUri() @@ -390,7 +486,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -401,7 +499,9 @@ public function setUri($uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BccEmailArchiveHistory.php b/src/Model/BccEmailArchiveHistory.php index 74f4b28e..db6b0761 100644 --- a/src/Model/BccEmailArchiveHistory.php +++ b/src/Model/BccEmailArchiveHistory.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BccEmailArchiveHistory Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BccEmailArchiveHistory implements ArrayAccess +class BccEmailArchiveHistory implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bccEmailArchiveHistory'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class BccEmailArchiveHistory implements ArrayAccess 'status' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_id' => null, + 'action' => null, + 'email' => null, + 'modified' => null, + 'modified_by' => null, + 'status' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'status' => 'status' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'status' => 'setStatus' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'status' => 'getStatus' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_id + * * @return string */ public function getAccountId() @@ -181,7 +246,9 @@ public function getAccountId() /** * Sets account_id + * * @param string $account_id The account ID associated with the envelope. + * * @return $this */ public function setAccountId($account_id) @@ -193,6 +260,7 @@ public function setAccountId($account_id) /** * Gets action + * * @return string */ public function getAction() @@ -202,7 +270,9 @@ public function getAction() /** * Sets action + * * @param string $action + * * @return $this */ public function setAction($action) @@ -214,6 +284,7 @@ public function setAction($action) /** * Gets email + * * @return string */ public function getEmail() @@ -223,7 +294,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -235,6 +308,7 @@ public function setEmail($email) /** * Gets modified + * * @return string */ public function getModified() @@ -244,7 +318,9 @@ public function getModified() /** * Sets modified + * * @param string $modified + * * @return $this */ public function setModified($modified) @@ -256,6 +332,7 @@ public function setModified($modified) /** * Gets modified_by + * * @return \DocuSign\eSign\Model\UserInfo */ public function getModifiedBy() @@ -265,7 +342,9 @@ public function getModifiedBy() /** * Sets modified_by - * @param \DocuSign\eSign\Model\UserInfo $modified_by + * + * @param \DocuSign\eSign\Model\UserInfo $modified_by modified_by + * * @return $this */ public function setModifiedBy($modified_by) @@ -277,6 +356,7 @@ public function setModifiedBy($modified_by) /** * Gets status + * * @return string */ public function getStatus() @@ -286,7 +366,9 @@ public function getStatus() /** * 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) @@ -297,7 +379,9 @@ public function setStatus($status) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BccEmailArchiveHistoryList.php b/src/Model/BccEmailArchiveHistoryList.php index 42ccc57d..87afc40f 100644 --- a/src/Model/BccEmailArchiveHistoryList.php +++ b/src/Model/BccEmailArchiveHistoryList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BccEmailArchiveHistoryList Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BccEmailArchiveHistoryList implements ArrayAccess +class BccEmailArchiveHistoryList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bccEmailArchiveHistoryList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class BccEmailArchiveHistoryList implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bcc_email_archive_history' => null, + 'end_position' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bcc_email_archive_history + * * @return \DocuSign\eSign\Model\BccEmailArchiveHistory[] */ public function getBccEmailArchiveHistory() @@ -186,7 +252,9 @@ public function getBccEmailArchiveHistory() /** * Sets bcc_email_archive_history + * * @param \DocuSign\eSign\Model\BccEmailArchiveHistory[] $bcc_email_archive_history + * * @return $this */ public function setBccEmailArchiveHistory($bcc_email_archive_history) @@ -198,6 +266,7 @@ public function setBccEmailArchiveHistory($bcc_email_archive_history) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -207,7 +276,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -219,6 +290,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -228,7 +300,9 @@ public function getNextUri() /** * 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) @@ -240,6 +314,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BccEmailArchiveList.php b/src/Model/BccEmailArchiveList.php index 7aa223bb..3c065a97 100644 --- a/src/Model/BccEmailArchiveList.php +++ b/src/Model/BccEmailArchiveList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BccEmailArchiveList Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BccEmailArchiveList implements ArrayAccess +class BccEmailArchiveList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bccEmailArchiveList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class BccEmailArchiveList implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bcc_email_archives' => null, + 'end_position' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bcc_email_archives + * * @return \DocuSign\eSign\Model\BccEmailArchive[] */ public function getBccEmailArchives() @@ -186,7 +252,9 @@ public function getBccEmailArchives() /** * Sets bcc_email_archives + * * @param \DocuSign\eSign\Model\BccEmailArchive[] $bcc_email_archives + * * @return $this */ public function setBccEmailArchives($bcc_email_archives) @@ -198,6 +266,7 @@ public function setBccEmailArchives($bcc_email_archives) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -207,7 +276,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -219,6 +290,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -228,7 +300,9 @@ public function getNextUri() /** * 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) @@ -240,6 +314,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingCharge.php b/src/Model/BillingCharge.php index be7f98ef..cbcd0f0c 100644 --- a/src/Model/BillingCharge.php +++ b/src/Model/BillingCharge.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingCharge Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingCharge implements ArrayAccess +class BillingCharge implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingCharge'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -70,13 +73,51 @@ class BillingCharge implements ArrayAccess 'used_quantity' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allowed_quantity' => null, + 'blocked' => null, + 'charge_name' => null, + 'charge_type' => null, + 'charge_unit_of_measure' => null, + 'discounts' => null, + 'first_effective_date' => null, + 'included_quantity' => null, + 'incremental_quantity' => null, + 'last_effective_date' => null, + 'prices' => null, + 'unit_price' => null, + 'used_quantity' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -95,9 +136,9 @@ public static function swaggerTypes() 'used_quantity' => 'usedQuantity' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -116,9 +157,9 @@ public static function swaggerTypes() 'used_quantity' => 'setUsedQuantity' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -137,34 +178,63 @@ public static function swaggerTypes() 'used_quantity' => 'getUsedQuantity' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -184,30 +254,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allowed_quantity + * * @return string */ public function getAllowedQuantity() @@ -217,7 +289,9 @@ public function getAllowedQuantity() /** * Sets allowed_quantity + * * @param string $allowed_quantity Reserved: TBD + * * @return $this */ public function setAllowedQuantity($allowed_quantity) @@ -229,6 +303,7 @@ public function setAllowedQuantity($allowed_quantity) /** * Gets blocked + * * @return string */ public function getBlocked() @@ -238,7 +313,9 @@ public function getBlocked() /** * Sets blocked + * * @param string $blocked Reserved: TBD + * * @return $this */ public function setBlocked($blocked) @@ -250,6 +327,7 @@ public function setBlocked($blocked) /** * Gets charge_name + * * @return string */ public function getChargeName() @@ -259,7 +337,9 @@ 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 | + * * @return $this */ public function setChargeName($charge_name) @@ -271,6 +351,7 @@ public function setChargeName($charge_name) /** * Gets charge_type + * * @return string */ public function getChargeType() @@ -280,7 +361,9 @@ public function getChargeType() /** * Sets charge_type + * * @param string $charge_type Reserved: TBD + * * @return $this */ public function setChargeType($charge_type) @@ -292,6 +375,7 @@ public function setChargeType($charge_type) /** * Gets charge_unit_of_measure + * * @return string */ public function getChargeUnitOfMeasure() @@ -301,7 +385,9 @@ public function getChargeUnitOfMeasure() /** * Sets charge_unit_of_measure + * * @param string $charge_unit_of_measure Reserved: TBD + * * @return $this */ public function setChargeUnitOfMeasure($charge_unit_of_measure) @@ -313,6 +399,7 @@ public function setChargeUnitOfMeasure($charge_unit_of_measure) /** * Gets discounts + * * @return \DocuSign\eSign\Model\BillingDiscount[] */ public function getDiscounts() @@ -322,7 +409,9 @@ public function getDiscounts() /** * Sets discounts + * * @param \DocuSign\eSign\Model\BillingDiscount[] $discounts + * * @return $this */ public function setDiscounts($discounts) @@ -334,6 +423,7 @@ public function setDiscounts($discounts) /** * Gets first_effective_date + * * @return string */ public function getFirstEffectiveDate() @@ -343,7 +433,9 @@ public function getFirstEffectiveDate() /** * Sets first_effective_date + * * @param string $first_effective_date + * * @return $this */ public function setFirstEffectiveDate($first_effective_date) @@ -355,6 +447,7 @@ public function setFirstEffectiveDate($first_effective_date) /** * Gets included_quantity + * * @return string */ public function getIncludedQuantity() @@ -364,7 +457,9 @@ public function getIncludedQuantity() /** * Sets included_quantity + * * @param string $included_quantity + * * @return $this */ public function setIncludedQuantity($included_quantity) @@ -376,6 +471,7 @@ public function setIncludedQuantity($included_quantity) /** * Gets incremental_quantity + * * @return string */ public function getIncrementalQuantity() @@ -385,7 +481,9 @@ public function getIncrementalQuantity() /** * Sets incremental_quantity + * * @param string $incremental_quantity Reserved: TBD + * * @return $this */ public function setIncrementalQuantity($incremental_quantity) @@ -397,6 +495,7 @@ public function setIncrementalQuantity($incremental_quantity) /** * Gets last_effective_date + * * @return string */ public function getLastEffectiveDate() @@ -406,7 +505,9 @@ public function getLastEffectiveDate() /** * Sets last_effective_date + * * @param string $last_effective_date + * * @return $this */ public function setLastEffectiveDate($last_effective_date) @@ -418,6 +519,7 @@ public function setLastEffectiveDate($last_effective_date) /** * Gets prices + * * @return \DocuSign\eSign\Model\BillingPrice[] */ public function getPrices() @@ -427,7 +529,9 @@ public function getPrices() /** * Sets prices + * * @param \DocuSign\eSign\Model\BillingPrice[] $prices + * * @return $this */ public function setPrices($prices) @@ -439,6 +543,7 @@ public function setPrices($prices) /** * Gets unit_price + * * @return string */ public function getUnitPrice() @@ -448,7 +553,9 @@ public function getUnitPrice() /** * Sets unit_price + * * @param string $unit_price Reserved: TBD + * * @return $this */ public function setUnitPrice($unit_price) @@ -460,6 +567,7 @@ public function setUnitPrice($unit_price) /** * Gets used_quantity + * * @return string */ public function getUsedQuantity() @@ -469,7 +577,9 @@ public function getUsedQuantity() /** * Sets used_quantity + * * @param string $used_quantity + * * @return $this */ public function setUsedQuantity($used_quantity) @@ -480,7 +590,9 @@ public function setUsedQuantity($used_quantity) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -490,7 +602,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -500,8 +614,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -515,7 +631,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -525,16 +643,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingChargeResponse.php b/src/Model/BillingChargeResponse.php index afdc362d..0d2039ab 100644 --- a/src/Model/BillingChargeResponse.php +++ b/src/Model/BillingChargeResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingChargeResponse Class Doc Comment @@ -40,83 +41,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingChargeResponse implements ArrayAccess +class BillingChargeResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingChargeResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'billing_charge_items' => '\DocuSign\eSign\Model\BillingCharge[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'billing_charge_items' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'billing_charge_items' => 'billingChargeItems' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'billing_charge_items' => 'setBillingChargeItems' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'billing_charge_items' => 'getBillingChargeItems' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -124,30 +182,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets billing_charge_items + * * @return \DocuSign\eSign\Model\BillingCharge[] */ public function getBillingChargeItems() @@ -157,7 +217,9 @@ public function getBillingChargeItems() /** * Sets billing_charge_items + * * @param \DocuSign\eSign\Model\BillingCharge[] $billing_charge_items Reserved: TBD + * * @return $this */ public function setBillingChargeItems($billing_charge_items) @@ -168,7 +230,9 @@ public function setBillingChargeItems($billing_charge_items) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -178,7 +242,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -188,8 +254,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -203,7 +271,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -213,16 +283,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingDiscount.php b/src/Model/BillingDiscount.php index 69d273f7..5d7f4cb8 100644 --- a/src/Model/BillingDiscount.php +++ b/src/Model/BillingDiscount.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingDiscount Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingDiscount implements ArrayAccess +class BillingDiscount implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingDiscount'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class BillingDiscount implements ArrayAccess 'end_quantity' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'begin_quantity' => null, + 'discount' => null, + 'end_quantity' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'end_quantity' => 'endQuantity' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'end_quantity' => 'setEndQuantity' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'end_quantity' => 'getEndQuantity' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets begin_quantity + * * @return string */ public function getBeginQuantity() @@ -166,7 +228,9 @@ public function getBeginQuantity() /** * Sets begin_quantity + * * @param string $begin_quantity Reserved: TBD + * * @return $this */ public function setBeginQuantity($begin_quantity) @@ -178,6 +242,7 @@ public function setBeginQuantity($begin_quantity) /** * Gets discount + * * @return string */ public function getDiscount() @@ -187,7 +252,9 @@ public function getDiscount() /** * Sets discount + * * @param string $discount + * * @return $this */ public function setDiscount($discount) @@ -199,6 +266,7 @@ public function setDiscount($discount) /** * Gets end_quantity + * * @return string */ public function getEndQuantity() @@ -208,7 +276,9 @@ public function getEndQuantity() /** * Sets end_quantity + * * @param string $end_quantity + * * @return $this */ public function setEndQuantity($end_quantity) @@ -219,7 +289,9 @@ public function setEndQuantity($end_quantity) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingInvoice.php b/src/Model/BillingInvoice.php index 36bf8182..28b25cef 100644 --- a/src/Model/BillingInvoice.php +++ b/src/Model/BillingInvoice.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingInvoice Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingInvoice implements ArrayAccess +class BillingInvoice implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingInvoice'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -67,13 +70,48 @@ class BillingInvoice implements ArrayAccess 'taxable_amount' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'amount' => null, + 'balance' => null, + 'due_date' => null, + 'invoice_id' => null, + 'invoice_items' => null, + 'invoice_number' => null, + 'invoice_uri' => null, + 'non_taxable_amount' => null, + 'pdf_available' => null, + 'taxable_amount' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -89,9 +127,9 @@ public static function swaggerTypes() 'taxable_amount' => 'taxableAmount' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -107,9 +145,9 @@ public static function swaggerTypes() 'taxable_amount' => 'setTaxableAmount' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -125,34 +163,63 @@ public static function swaggerTypes() 'taxable_amount' => 'getTaxableAmount' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -169,30 +236,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets amount + * * @return string */ public function getAmount() @@ -202,7 +271,9 @@ public function getAmount() /** * Sets amount + * * @param string $amount Reserved: TBD + * * @return $this */ public function setAmount($amount) @@ -214,6 +285,7 @@ public function setAmount($amount) /** * Gets balance + * * @return string */ public function getBalance() @@ -223,7 +295,9 @@ public function getBalance() /** * Sets balance + * * @param string $balance Reserved: TBD + * * @return $this */ public function setBalance($balance) @@ -235,6 +309,7 @@ public function setBalance($balance) /** * Gets due_date + * * @return string */ public function getDueDate() @@ -244,7 +319,9 @@ public function getDueDate() /** * Sets due_date + * * @param string $due_date Reserved: TBD + * * @return $this */ public function setDueDate($due_date) @@ -256,6 +333,7 @@ public function setDueDate($due_date) /** * Gets invoice_id + * * @return string */ public function getInvoiceId() @@ -265,7 +343,9 @@ public function getInvoiceId() /** * Sets invoice_id + * * @param string $invoice_id Reserved: TBD + * * @return $this */ public function setInvoiceId($invoice_id) @@ -277,6 +357,7 @@ public function setInvoiceId($invoice_id) /** * Gets invoice_items + * * @return \DocuSign\eSign\Model\BillingInvoiceItem[] */ public function getInvoiceItems() @@ -286,7 +367,9 @@ public function getInvoiceItems() /** * Sets invoice_items + * * @param \DocuSign\eSign\Model\BillingInvoiceItem[] $invoice_items Reserved: TBD + * * @return $this */ public function setInvoiceItems($invoice_items) @@ -298,6 +381,7 @@ public function setInvoiceItems($invoice_items) /** * Gets invoice_number + * * @return string */ public function getInvoiceNumber() @@ -307,7 +391,9 @@ public function getInvoiceNumber() /** * Sets invoice_number + * * @param string $invoice_number Reserved: TBD + * * @return $this */ public function setInvoiceNumber($invoice_number) @@ -319,6 +405,7 @@ public function setInvoiceNumber($invoice_number) /** * Gets invoice_uri + * * @return string */ public function getInvoiceUri() @@ -328,7 +415,9 @@ public function getInvoiceUri() /** * Sets invoice_uri + * * @param string $invoice_uri Contains a URI for an endpoint that you can use to retrieve invoice information. + * * @return $this */ public function setInvoiceUri($invoice_uri) @@ -340,6 +429,7 @@ public function setInvoiceUri($invoice_uri) /** * Gets non_taxable_amount + * * @return string */ public function getNonTaxableAmount() @@ -349,7 +439,9 @@ public function getNonTaxableAmount() /** * Sets non_taxable_amount + * * @param string $non_taxable_amount + * * @return $this */ public function setNonTaxableAmount($non_taxable_amount) @@ -361,6 +453,7 @@ public function setNonTaxableAmount($non_taxable_amount) /** * Gets pdf_available + * * @return string */ public function getPdfAvailable() @@ -370,7 +463,9 @@ public function getPdfAvailable() /** * Sets pdf_available + * * @param string $pdf_available + * * @return $this */ public function setPdfAvailable($pdf_available) @@ -382,6 +477,7 @@ public function setPdfAvailable($pdf_available) /** * Gets taxable_amount + * * @return string */ public function getTaxableAmount() @@ -391,7 +487,9 @@ public function getTaxableAmount() /** * Sets taxable_amount + * * @param string $taxable_amount + * * @return $this */ public function setTaxableAmount($taxable_amount) @@ -402,7 +500,9 @@ public function setTaxableAmount($taxable_amount) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -412,7 +512,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -422,8 +524,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -437,7 +541,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -447,16 +553,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingInvoiceItem.php b/src/Model/BillingInvoiceItem.php index 10437c29..6572b9fd 100644 --- a/src/Model/BillingInvoiceItem.php +++ b/src/Model/BillingInvoiceItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingInvoiceItem Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingInvoiceItem implements ArrayAccess +class BillingInvoiceItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingInvoiceItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,43 @@ class BillingInvoiceItem implements ArrayAccess 'unit_price' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'charge_amount' => null, + 'charge_name' => null, + 'invoice_item_id' => null, + 'quantity' => null, + 'unit_price' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -79,9 +112,9 @@ public static function swaggerTypes() 'unit_price' => 'unitPrice' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -92,9 +125,9 @@ public static function swaggerTypes() 'unit_price' => 'setUnitPrice' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -105,34 +138,63 @@ public static function swaggerTypes() 'unit_price' => 'getUnitPrice' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -144,30 +206,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets charge_amount + * * @return string */ public function getChargeAmount() @@ -177,7 +241,9 @@ public function getChargeAmount() /** * Sets charge_amount + * * @param string $charge_amount Reserved: TBD + * * @return $this */ public function setChargeAmount($charge_amount) @@ -189,6 +255,7 @@ public function setChargeAmount($charge_amount) /** * Gets charge_name + * * @return string */ public function getChargeName() @@ -198,7 +265,9 @@ public function getChargeName() /** * Sets charge_name + * * @param string $charge_name Reserved: TBD + * * @return $this */ public function setChargeName($charge_name) @@ -210,6 +279,7 @@ public function setChargeName($charge_name) /** * Gets invoice_item_id + * * @return string */ public function getInvoiceItemId() @@ -219,7 +289,9 @@ public function getInvoiceItemId() /** * Sets invoice_item_id + * * @param string $invoice_item_id Reserved: TBD + * * @return $this */ public function setInvoiceItemId($invoice_item_id) @@ -231,6 +303,7 @@ public function setInvoiceItemId($invoice_item_id) /** * Gets quantity + * * @return string */ public function getQuantity() @@ -240,7 +313,9 @@ public function getQuantity() /** * Sets quantity + * * @param string $quantity + * * @return $this */ public function setQuantity($quantity) @@ -252,6 +327,7 @@ public function setQuantity($quantity) /** * Gets unit_price + * * @return string */ public function getUnitPrice() @@ -261,7 +337,9 @@ public function getUnitPrice() /** * Sets unit_price + * * @param string $unit_price Reserved: TBD + * * @return $this */ public function setUnitPrice($unit_price) @@ -272,7 +350,9 @@ public function setUnitPrice($unit_price) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -282,7 +362,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -292,8 +374,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -307,7 +391,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -317,16 +403,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingInvoicesResponse.php b/src/Model/BillingInvoicesResponse.php index b131d884..fe3bc127 100644 --- a/src/Model/BillingInvoicesResponse.php +++ b/src/Model/BillingInvoicesResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingInvoicesResponse Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingInvoicesResponse implements ArrayAccess +class BillingInvoicesResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingInvoicesResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class BillingInvoicesResponse implements ArrayAccess 'previous_uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'billing_invoices' => null, + 'next_uri' => null, + 'previous_uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'previous_uri' => 'previousUri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'previous_uri' => 'setPreviousUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'previous_uri' => 'getPreviousUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets billing_invoices + * * @return \DocuSign\eSign\Model\BillingInvoice[] */ public function getBillingInvoices() @@ -167,7 +229,9 @@ public function getBillingInvoices() /** * Sets billing_invoices + * * @param \DocuSign\eSign\Model\BillingInvoice[] $billing_invoices Reserved: TBD + * * @return $this */ public function setBillingInvoices($billing_invoices) @@ -179,6 +243,7 @@ public function setBillingInvoices($billing_invoices) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -188,7 +253,9 @@ public function getNextUri() /** * 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) @@ -200,6 +267,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -209,7 +277,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -220,7 +290,9 @@ public function setPreviousUri($previous_uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingInvoicesSummary.php b/src/Model/BillingInvoicesSummary.php index b55acd2b..cab25467 100644 --- a/src/Model/BillingInvoicesSummary.php +++ b/src/Model/BillingInvoicesSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingInvoicesSummary Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingInvoicesSummary implements ArrayAccess +class BillingInvoicesSummary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingInvoicesSummary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class BillingInvoicesSummary implements ArrayAccess 'payment_allowed' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'billing_invoices' => null, + 'past_due_balance' => null, + 'payment_allowed' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'payment_allowed' => 'paymentAllowed' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'payment_allowed' => 'setPaymentAllowed' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'payment_allowed' => 'getPaymentAllowed' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets billing_invoices + * * @return \DocuSign\eSign\Model\BillingInvoice[] */ public function getBillingInvoices() @@ -166,7 +228,9 @@ public function getBillingInvoices() /** * Sets billing_invoices + * * @param \DocuSign\eSign\Model\BillingInvoice[] $billing_invoices Reserved: TBD + * * @return $this */ public function setBillingInvoices($billing_invoices) @@ -178,6 +242,7 @@ public function setBillingInvoices($billing_invoices) /** * Gets past_due_balance + * * @return string */ public function getPastDueBalance() @@ -187,7 +252,9 @@ public function getPastDueBalance() /** * Sets past_due_balance + * * @param string $past_due_balance + * * @return $this */ public function setPastDueBalance($past_due_balance) @@ -199,6 +266,7 @@ public function setPastDueBalance($past_due_balance) /** * Gets payment_allowed + * * @return string */ public function getPaymentAllowed() @@ -208,7 +276,9 @@ public function getPaymentAllowed() /** * Sets payment_allowed + * * @param string $payment_allowed + * * @return $this */ public function setPaymentAllowed($payment_allowed) @@ -219,7 +289,9 @@ public function setPaymentAllowed($payment_allowed) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPayment.php b/src/Model/BillingPayment.php index 997ba122..59a32d2c 100644 --- a/src/Model/BillingPayment.php +++ b/src/Model/BillingPayment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPayment Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPayment implements ArrayAccess +class BillingPayment implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPayment'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class BillingPayment implements ArrayAccess 'payment_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'amount' => null, + 'invoice_id' => null, + 'payment_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'payment_id' => 'paymentId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'payment_id' => 'setPaymentId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'payment_id' => 'getPaymentId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets amount + * * @return string */ public function getAmount() @@ -167,7 +229,9 @@ public function getAmount() /** * Sets amount + * * @param string $amount Reserved: TBD + * * @return $this */ public function setAmount($amount) @@ -179,6 +243,7 @@ public function setAmount($amount) /** * Gets invoice_id + * * @return string */ public function getInvoiceId() @@ -188,7 +253,9 @@ public function getInvoiceId() /** * Sets invoice_id + * * @param string $invoice_id Reserved: TBD + * * @return $this */ public function setInvoiceId($invoice_id) @@ -200,6 +267,7 @@ public function setInvoiceId($invoice_id) /** * Gets payment_id + * * @return string */ public function getPaymentId() @@ -209,7 +277,9 @@ public function getPaymentId() /** * Sets payment_id + * * @param string $payment_id + * * @return $this */ public function setPaymentId($payment_id) @@ -220,7 +290,9 @@ public function setPaymentId($payment_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPaymentItem.php b/src/Model/BillingPaymentItem.php index 8234ee8e..b1551c79 100644 --- a/src/Model/BillingPaymentItem.php +++ b/src/Model/BillingPaymentItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPaymentItem Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPaymentItem implements ArrayAccess +class BillingPaymentItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPaymentItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,43 @@ class BillingPaymentItem implements ArrayAccess 'payment_number' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'amount' => null, + 'description' => null, + 'payment_date' => null, + 'payment_id' => null, + 'payment_number' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -79,9 +112,9 @@ public static function swaggerTypes() 'payment_number' => 'paymentNumber' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -92,9 +125,9 @@ public static function swaggerTypes() 'payment_number' => 'setPaymentNumber' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -105,34 +138,63 @@ public static function swaggerTypes() 'payment_number' => 'getPaymentNumber' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -144,30 +206,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets amount + * * @return string */ public function getAmount() @@ -177,7 +241,9 @@ public function getAmount() /** * Sets amount + * * @param string $amount Reserved: TBD + * * @return $this */ public function setAmount($amount) @@ -189,6 +255,7 @@ public function setAmount($amount) /** * Gets description + * * @return string */ public function getDescription() @@ -198,7 +265,9 @@ public function getDescription() /** * Sets description + * * @param string $description + * * @return $this */ public function setDescription($description) @@ -210,6 +279,7 @@ public function setDescription($description) /** * Gets payment_date + * * @return string */ public function getPaymentDate() @@ -219,7 +289,9 @@ public function getPaymentDate() /** * Sets payment_date + * * @param string $payment_date + * * @return $this */ public function setPaymentDate($payment_date) @@ -231,6 +303,7 @@ public function setPaymentDate($payment_date) /** * Gets payment_id + * * @return string */ public function getPaymentId() @@ -240,7 +313,9 @@ public function getPaymentId() /** * Sets payment_id + * * @param string $payment_id + * * @return $this */ public function setPaymentId($payment_id) @@ -252,6 +327,7 @@ public function setPaymentId($payment_id) /** * Gets payment_number + * * @return string */ public function getPaymentNumber() @@ -261,7 +337,9 @@ public function getPaymentNumber() /** * Sets payment_number + * * @param string $payment_number When set to **true**, a PDF version of the invoice is available. To get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\". + * * @return $this */ public function setPaymentNumber($payment_number) @@ -272,7 +350,9 @@ public function setPaymentNumber($payment_number) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -282,7 +362,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -292,8 +374,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -307,7 +391,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -317,16 +403,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPaymentRequest.php b/src/Model/BillingPaymentRequest.php index 1c9d816e..65f78b98 100644 --- a/src/Model/BillingPaymentRequest.php +++ b/src/Model/BillingPaymentRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPaymentRequest Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPaymentRequest implements ArrayAccess +class BillingPaymentRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPaymentRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'payment_amount' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'payment_amount' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'payment_amount' => 'paymentAmount' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'payment_amount' => 'setPaymentAmount' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'payment_amount' => 'getPaymentAmount' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets payment_amount + * * @return string */ public function getPaymentAmount() @@ -156,7 +216,9 @@ public function getPaymentAmount() /** * Sets payment_amount + * * @param string $payment_amount The payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices. + * * @return $this */ public function setPaymentAmount($payment_amount) @@ -167,7 +229,9 @@ public function setPaymentAmount($payment_amount) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPaymentResponse.php b/src/Model/BillingPaymentResponse.php index 3cc3228e..27ffee15 100644 --- a/src/Model/BillingPaymentResponse.php +++ b/src/Model/BillingPaymentResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPaymentResponse Class Doc Comment @@ -40,83 +41,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPaymentResponse implements ArrayAccess +class BillingPaymentResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPaymentResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'billing_payments' => '\DocuSign\eSign\Model\BillingPayment[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'billing_payments' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'billing_payments' => 'billingPayments' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'billing_payments' => 'setBillingPayments' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'billing_payments' => 'getBillingPayments' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -124,30 +182,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets billing_payments + * * @return \DocuSign\eSign\Model\BillingPayment[] */ public function getBillingPayments() @@ -157,7 +217,9 @@ public function getBillingPayments() /** * Sets billing_payments + * * @param \DocuSign\eSign\Model\BillingPayment[] $billing_payments Reserved: TBD + * * @return $this */ public function setBillingPayments($billing_payments) @@ -168,7 +230,9 @@ public function setBillingPayments($billing_payments) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -178,7 +242,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -188,8 +254,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -203,7 +271,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -213,16 +283,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPaymentsResponse.php b/src/Model/BillingPaymentsResponse.php index 6da5a59a..1bbde575 100644 --- a/src/Model/BillingPaymentsResponse.php +++ b/src/Model/BillingPaymentsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPaymentsResponse Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPaymentsResponse implements ArrayAccess +class BillingPaymentsResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPaymentsResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class BillingPaymentsResponse implements ArrayAccess 'previous_uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'billing_payments' => null, + 'next_uri' => null, + 'previous_uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'previous_uri' => 'previousUri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'previous_uri' => 'setPreviousUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'previous_uri' => 'getPreviousUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets billing_payments + * * @return \DocuSign\eSign\Model\BillingPaymentItem[] */ public function getBillingPayments() @@ -167,7 +229,9 @@ public function getBillingPayments() /** * Sets billing_payments + * * @param \DocuSign\eSign\Model\BillingPaymentItem[] $billing_payments Reserved: TBD + * * @return $this */ public function setBillingPayments($billing_payments) @@ -179,6 +243,7 @@ public function setBillingPayments($billing_payments) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -188,7 +253,9 @@ public function getNextUri() /** * 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) @@ -200,6 +267,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -209,7 +277,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -220,7 +290,9 @@ public function setPreviousUri($previous_uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPlan.php b/src/Model/BillingPlan.php index db45328f..e1529cf9 100644 --- a/src/Model/BillingPlan.php +++ b/src/Model/BillingPlan.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPlan Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPlan implements ArrayAccess +class BillingPlan implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPlan'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -72,13 +75,53 @@ class BillingPlan implements ArrayAccess 'support_plan_fee' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'app_store_products' => null, + 'currency_plan_prices' => null, + 'enable_support' => null, + 'included_seats' => null, + 'other_discount_percent' => null, + 'payment_cycle' => null, + 'payment_method' => null, + 'per_seat_price' => null, + 'plan_classification' => null, + 'plan_feature_sets' => null, + 'plan_id' => null, + 'plan_name' => null, + 'seat_discounts' => null, + 'support_incident_fee' => null, + 'support_plan_fee' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -99,9 +142,9 @@ public static function swaggerTypes() 'support_plan_fee' => 'supportPlanFee' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -122,9 +165,9 @@ public static function swaggerTypes() 'support_plan_fee' => 'setSupportPlanFee' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -145,34 +188,63 @@ public static function swaggerTypes() 'support_plan_fee' => 'getSupportPlanFee' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -194,30 +266,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets app_store_products + * * @return \DocuSign\eSign\Model\AppStoreProduct[] */ public function getAppStoreProducts() @@ -227,7 +301,9 @@ public function getAppStoreProducts() /** * Sets app_store_products + * * @param \DocuSign\eSign\Model\AppStoreProduct[] $app_store_products Reserved: TBD + * * @return $this */ public function setAppStoreProducts($app_store_products) @@ -239,6 +315,7 @@ public function setAppStoreProducts($app_store_products) /** * Gets currency_plan_prices + * * @return \DocuSign\eSign\Model\CurrencyPlanPrice[] */ public function getCurrencyPlanPrices() @@ -248,7 +325,9 @@ public function getCurrencyPlanPrices() /** * Sets currency_plan_prices + * * @param \DocuSign\eSign\Model\CurrencyPlanPrice[] $currency_plan_prices Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set. + * * @return $this */ public function setCurrencyPlanPrices($currency_plan_prices) @@ -260,6 +339,7 @@ public function setCurrencyPlanPrices($currency_plan_prices) /** * Gets enable_support + * * @return string */ public function getEnableSupport() @@ -269,7 +349,9 @@ public function getEnableSupport() /** * Sets enable_support + * * @param string $enable_support When set to **true**, then customer support is provided as part of the account plan. + * * @return $this */ public function setEnableSupport($enable_support) @@ -281,6 +363,7 @@ public function setEnableSupport($enable_support) /** * Gets included_seats + * * @return string */ public function getIncludedSeats() @@ -290,7 +373,9 @@ public function getIncludedSeats() /** * Sets included_seats + * * @param string $included_seats The number of seats (users) included. + * * @return $this */ public function setIncludedSeats($included_seats) @@ -302,6 +387,7 @@ public function setIncludedSeats($included_seats) /** * Gets other_discount_percent + * * @return string */ public function getOtherDiscountPercent() @@ -311,7 +397,9 @@ public function getOtherDiscountPercent() /** * Sets other_discount_percent + * * @param string $other_discount_percent + * * @return $this */ public function setOtherDiscountPercent($other_discount_percent) @@ -323,6 +411,7 @@ public function setOtherDiscountPercent($other_discount_percent) /** * Gets payment_cycle + * * @return string */ public function getPaymentCycle() @@ -332,7 +421,9 @@ public function getPaymentCycle() /** * Sets payment_cycle + * * @param string $payment_cycle The payment cycle associated with the plan. The possible values are: Monthly or Annually. + * * @return $this */ public function setPaymentCycle($payment_cycle) @@ -344,6 +435,7 @@ public function setPaymentCycle($payment_cycle) /** * Gets payment_method + * * @return string */ public function getPaymentMethod() @@ -353,7 +445,9 @@ public function getPaymentMethod() /** * Sets payment_method + * * @param string $payment_method + * * @return $this */ public function setPaymentMethod($payment_method) @@ -365,6 +459,7 @@ public function setPaymentMethod($payment_method) /** * Gets per_seat_price + * * @return string */ public function getPerSeatPrice() @@ -374,7 +469,9 @@ public function getPerSeatPrice() /** * Sets per_seat_price + * * @param string $per_seat_price The per seat price for the plan. + * * @return $this */ public function setPerSeatPrice($per_seat_price) @@ -386,6 +483,7 @@ public function setPerSeatPrice($per_seat_price) /** * Gets plan_classification + * * @return string */ public function getPlanClassification() @@ -395,7 +493,9 @@ public function getPlanClassification() /** * Sets plan_classification + * * @param string $plan_classification Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. + * * @return $this */ public function setPlanClassification($plan_classification) @@ -407,6 +507,7 @@ public function setPlanClassification($plan_classification) /** * Gets plan_feature_sets + * * @return \DocuSign\eSign\Model\FeatureSet[] */ public function getPlanFeatureSets() @@ -416,7 +517,9 @@ public function getPlanFeatureSets() /** * Sets plan_feature_sets + * * @param \DocuSign\eSign\Model\FeatureSet[] $plan_feature_sets + * * @return $this */ public function setPlanFeatureSets($plan_feature_sets) @@ -428,6 +531,7 @@ public function setPlanFeatureSets($plan_feature_sets) /** * Gets plan_id + * * @return string */ public function getPlanId() @@ -437,7 +541,9 @@ public function getPlanId() /** * Sets plan_id + * * @param string $plan_id + * * @return $this */ public function setPlanId($plan_id) @@ -449,6 +555,7 @@ public function setPlanId($plan_id) /** * Gets plan_name + * * @return string */ public function getPlanName() @@ -458,7 +565,9 @@ public function getPlanName() /** * Sets plan_name + * * @param string $plan_name The name of the Billing Plan. + * * @return $this */ public function setPlanName($plan_name) @@ -470,6 +579,7 @@ public function setPlanName($plan_name) /** * Gets seat_discounts + * * @return \DocuSign\eSign\Model\SeatDiscount[] */ public function getSeatDiscounts() @@ -479,7 +589,9 @@ public function getSeatDiscounts() /** * Sets seat_discounts + * * @param \DocuSign\eSign\Model\SeatDiscount[] $seat_discounts + * * @return $this */ public function setSeatDiscounts($seat_discounts) @@ -491,6 +603,7 @@ public function setSeatDiscounts($seat_discounts) /** * Gets support_incident_fee + * * @return string */ public function getSupportIncidentFee() @@ -500,7 +613,9 @@ public function getSupportIncidentFee() /** * Sets support_incident_fee + * * @param string $support_incident_fee The support incident fee charged for each support incident. + * * @return $this */ public function setSupportIncidentFee($support_incident_fee) @@ -512,6 +627,7 @@ public function setSupportIncidentFee($support_incident_fee) /** * Gets support_plan_fee + * * @return string */ public function getSupportPlanFee() @@ -521,7 +637,9 @@ public function getSupportPlanFee() /** * Sets support_plan_fee + * * @param string $support_plan_fee The support plan fee charged for this plan. + * * @return $this */ public function setSupportPlanFee($support_plan_fee) @@ -532,7 +650,9 @@ public function setSupportPlanFee($support_plan_fee) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -542,7 +662,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -552,8 +674,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -567,7 +691,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -577,16 +703,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPlanInformation.php b/src/Model/BillingPlanInformation.php index 9c94c8d7..5d134dbc 100644 --- a/src/Model/BillingPlanInformation.php +++ b/src/Model/BillingPlanInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPlanInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPlanInformation implements ArrayAccess +class BillingPlanInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPlanInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -74,13 +77,56 @@ class BillingPlanInformation implements ArrayAccess 'sale_discount_seat_price_override' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'app_store_receipt' => null, + 'billing_address' => null, + 'credit_card_information' => null, + 'direct_debit_processor_information' => null, + 'downgrade_reason' => null, + 'enable_support' => null, + 'included_seats' => null, + 'incremental_seats' => null, + 'payment_method' => null, + 'payment_processor_information' => null, + 'plan_information' => null, + 'referral_information' => null, + 'renewal_status' => null, + 'sale_discount_amount' => null, + 'sale_discount_fixed_amount' => null, + 'sale_discount_percent' => null, + 'sale_discount_periods' => null, + 'sale_discount_seat_price_override' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -104,9 +150,9 @@ public static function swaggerTypes() 'sale_discount_seat_price_override' => 'saleDiscountSeatPriceOverride' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -130,9 +176,9 @@ public static function swaggerTypes() 'sale_discount_seat_price_override' => 'setSaleDiscountSeatPriceOverride' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -156,34 +202,63 @@ public static function swaggerTypes() 'sale_discount_seat_price_override' => 'getSaleDiscountSeatPriceOverride' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -208,30 +283,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets app_store_receipt + * * @return \DocuSign\eSign\Model\AppStoreReceipt */ public function getAppStoreReceipt() @@ -241,7 +318,9 @@ public function getAppStoreReceipt() /** * Sets app_store_receipt - * @param \DocuSign\eSign\Model\AppStoreReceipt $app_store_receipt + * + * @param \DocuSign\eSign\Model\AppStoreReceipt $app_store_receipt app_store_receipt + * * @return $this */ public function setAppStoreReceipt($app_store_receipt) @@ -253,6 +332,7 @@ public function setAppStoreReceipt($app_store_receipt) /** * Gets billing_address + * * @return \DocuSign\eSign\Model\AccountAddress */ public function getBillingAddress() @@ -262,7 +342,9 @@ public function getBillingAddress() /** * Sets billing_address - * @param \DocuSign\eSign\Model\AccountAddress $billing_address + * + * @param \DocuSign\eSign\Model\AccountAddress $billing_address billing_address + * * @return $this */ public function setBillingAddress($billing_address) @@ -274,6 +356,7 @@ public function setBillingAddress($billing_address) /** * Gets credit_card_information + * * @return \DocuSign\eSign\Model\CreditCardInformation */ public function getCreditCardInformation() @@ -283,7 +366,9 @@ public function getCreditCardInformation() /** * Sets credit_card_information - * @param \DocuSign\eSign\Model\CreditCardInformation $credit_card_information + * + * @param \DocuSign\eSign\Model\CreditCardInformation $credit_card_information credit_card_information + * * @return $this */ public function setCreditCardInformation($credit_card_information) @@ -295,6 +380,7 @@ public function setCreditCardInformation($credit_card_information) /** * Gets direct_debit_processor_information + * * @return \DocuSign\eSign\Model\DirectDebitProcessorInformation */ public function getDirectDebitProcessorInformation() @@ -304,7 +390,9 @@ public function getDirectDebitProcessorInformation() /** * Sets direct_debit_processor_information - * @param \DocuSign\eSign\Model\DirectDebitProcessorInformation $direct_debit_processor_information + * + * @param \DocuSign\eSign\Model\DirectDebitProcessorInformation $direct_debit_processor_information direct_debit_processor_information + * * @return $this */ public function setDirectDebitProcessorInformation($direct_debit_processor_information) @@ -316,6 +404,7 @@ public function setDirectDebitProcessorInformation($direct_debit_processor_infor /** * Gets downgrade_reason + * * @return string */ public function getDowngradeReason() @@ -325,7 +414,9 @@ public function getDowngradeReason() /** * Sets downgrade_reason + * * @param string $downgrade_reason + * * @return $this */ public function setDowngradeReason($downgrade_reason) @@ -337,6 +428,7 @@ public function setDowngradeReason($downgrade_reason) /** * Gets enable_support + * * @return string */ public function getEnableSupport() @@ -346,7 +438,9 @@ public function getEnableSupport() /** * Sets enable_support + * * @param string $enable_support + * * @return $this */ public function setEnableSupport($enable_support) @@ -358,6 +452,7 @@ public function setEnableSupport($enable_support) /** * Gets included_seats + * * @return string */ public function getIncludedSeats() @@ -367,7 +462,9 @@ public function getIncludedSeats() /** * Sets included_seats + * * @param string $included_seats The number of seats (users) included. + * * @return $this */ public function setIncludedSeats($included_seats) @@ -379,6 +476,7 @@ public function setIncludedSeats($included_seats) /** * Gets incremental_seats + * * @return string */ public function getIncrementalSeats() @@ -388,7 +486,9 @@ public function getIncrementalSeats() /** * Sets incremental_seats + * * @param string $incremental_seats Reserved: TBD + * * @return $this */ public function setIncrementalSeats($incremental_seats) @@ -400,6 +500,7 @@ public function setIncrementalSeats($incremental_seats) /** * Gets payment_method + * * @return string */ public function getPaymentMethod() @@ -409,7 +510,9 @@ public function getPaymentMethod() /** * Sets payment_method + * * @param string $payment_method + * * @return $this */ public function setPaymentMethod($payment_method) @@ -421,6 +524,7 @@ public function setPaymentMethod($payment_method) /** * Gets payment_processor_information + * * @return \DocuSign\eSign\Model\PaymentProcessorInformation */ public function getPaymentProcessorInformation() @@ -430,7 +534,9 @@ public function getPaymentProcessorInformation() /** * Sets payment_processor_information - * @param \DocuSign\eSign\Model\PaymentProcessorInformation $payment_processor_information + * + * @param \DocuSign\eSign\Model\PaymentProcessorInformation $payment_processor_information payment_processor_information + * * @return $this */ public function setPaymentProcessorInformation($payment_processor_information) @@ -442,6 +548,7 @@ public function setPaymentProcessorInformation($payment_processor_information) /** * Gets plan_information + * * @return \DocuSign\eSign\Model\PlanInformation */ public function getPlanInformation() @@ -451,7 +558,9 @@ public function getPlanInformation() /** * Sets plan_information - * @param \DocuSign\eSign\Model\PlanInformation $plan_information + * + * @param \DocuSign\eSign\Model\PlanInformation $plan_information plan_information + * * @return $this */ public function setPlanInformation($plan_information) @@ -463,6 +572,7 @@ public function setPlanInformation($plan_information) /** * Gets referral_information + * * @return \DocuSign\eSign\Model\ReferralInformation */ public function getReferralInformation() @@ -472,7 +582,9 @@ public function getReferralInformation() /** * Sets referral_information - * @param \DocuSign\eSign\Model\ReferralInformation $referral_information + * + * @param \DocuSign\eSign\Model\ReferralInformation $referral_information referral_information + * * @return $this */ public function setReferralInformation($referral_information) @@ -484,6 +596,7 @@ public function setReferralInformation($referral_information) /** * Gets renewal_status + * * @return string */ public function getRenewalStatus() @@ -493,7 +606,9 @@ public function getRenewalStatus() /** * Sets renewal_status + * * @param string $renewal_status + * * @return $this */ public function setRenewalStatus($renewal_status) @@ -505,6 +620,7 @@ public function setRenewalStatus($renewal_status) /** * Gets sale_discount_amount + * * @return string */ public function getSaleDiscountAmount() @@ -514,7 +630,9 @@ public function getSaleDiscountAmount() /** * Sets sale_discount_amount + * * @param string $sale_discount_amount + * * @return $this */ public function setSaleDiscountAmount($sale_discount_amount) @@ -526,6 +644,7 @@ public function setSaleDiscountAmount($sale_discount_amount) /** * Gets sale_discount_fixed_amount + * * @return string */ public function getSaleDiscountFixedAmount() @@ -535,7 +654,9 @@ public function getSaleDiscountFixedAmount() /** * Sets sale_discount_fixed_amount + * * @param string $sale_discount_fixed_amount + * * @return $this */ public function setSaleDiscountFixedAmount($sale_discount_fixed_amount) @@ -547,6 +668,7 @@ public function setSaleDiscountFixedAmount($sale_discount_fixed_amount) /** * Gets sale_discount_percent + * * @return string */ public function getSaleDiscountPercent() @@ -556,7 +678,9 @@ public function getSaleDiscountPercent() /** * Sets sale_discount_percent + * * @param string $sale_discount_percent + * * @return $this */ public function setSaleDiscountPercent($sale_discount_percent) @@ -568,6 +692,7 @@ public function setSaleDiscountPercent($sale_discount_percent) /** * Gets sale_discount_periods + * * @return string */ public function getSaleDiscountPeriods() @@ -577,7 +702,9 @@ public function getSaleDiscountPeriods() /** * Sets sale_discount_periods + * * @param string $sale_discount_periods + * * @return $this */ public function setSaleDiscountPeriods($sale_discount_periods) @@ -589,6 +716,7 @@ public function setSaleDiscountPeriods($sale_discount_periods) /** * Gets sale_discount_seat_price_override + * * @return string */ public function getSaleDiscountSeatPriceOverride() @@ -598,7 +726,9 @@ public function getSaleDiscountSeatPriceOverride() /** * Sets sale_discount_seat_price_override + * * @param string $sale_discount_seat_price_override + * * @return $this */ public function setSaleDiscountSeatPriceOverride($sale_discount_seat_price_override) @@ -609,7 +739,9 @@ public function setSaleDiscountSeatPriceOverride($sale_discount_seat_price_overr } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -619,7 +751,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -629,8 +763,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -644,7 +780,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -654,16 +792,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPlanPreview.php b/src/Model/BillingPlanPreview.php index c59d959f..117a5b93 100644 --- a/src/Model/BillingPlanPreview.php +++ b/src/Model/BillingPlanPreview.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPlanPreview Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPlanPreview implements ArrayAccess +class BillingPlanPreview implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPlanPreview'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,44 @@ class BillingPlanPreview implements ArrayAccess 'total_amount' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'currency_code' => null, + 'invoice' => null, + 'is_prorated' => null, + 'subtotal_amount' => null, + 'tax_amount' => null, + 'total_amount' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -81,9 +115,9 @@ public static function swaggerTypes() 'total_amount' => 'totalAmount' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -95,9 +129,9 @@ public static function swaggerTypes() 'total_amount' => 'setTotalAmount' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -109,34 +143,63 @@ public static function swaggerTypes() 'total_amount' => 'getTotalAmount' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -149,30 +212,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -182,7 +247,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code Specifies the ISO currency code for the account. + * * @return $this */ public function setCurrencyCode($currency_code) @@ -194,6 +261,7 @@ public function setCurrencyCode($currency_code) /** * Gets invoice + * * @return \DocuSign\eSign\Model\BillingInvoice */ public function getInvoice() @@ -203,7 +271,9 @@ public function getInvoice() /** * Sets invoice - * @param \DocuSign\eSign\Model\BillingInvoice $invoice + * + * @param \DocuSign\eSign\Model\BillingInvoice $invoice invoice + * * @return $this */ public function setInvoice($invoice) @@ -215,6 +285,7 @@ public function setInvoice($invoice) /** * Gets is_prorated + * * @return string */ public function getIsProrated() @@ -224,7 +295,9 @@ public function getIsProrated() /** * Sets is_prorated + * * @param string $is_prorated + * * @return $this */ public function setIsProrated($is_prorated) @@ -236,6 +309,7 @@ public function setIsProrated($is_prorated) /** * Gets subtotal_amount + * * @return string */ public function getSubtotalAmount() @@ -245,7 +319,9 @@ public function getSubtotalAmount() /** * Sets subtotal_amount + * * @param string $subtotal_amount + * * @return $this */ public function setSubtotalAmount($subtotal_amount) @@ -257,6 +333,7 @@ public function setSubtotalAmount($subtotal_amount) /** * Gets tax_amount + * * @return string */ public function getTaxAmount() @@ -266,7 +343,9 @@ public function getTaxAmount() /** * Sets tax_amount + * * @param string $tax_amount + * * @return $this */ public function setTaxAmount($tax_amount) @@ -278,6 +357,7 @@ public function setTaxAmount($tax_amount) /** * Gets total_amount + * * @return string */ public function getTotalAmount() @@ -287,7 +367,9 @@ public function getTotalAmount() /** * Sets total_amount + * * @param string $total_amount + * * @return $this */ public function setTotalAmount($total_amount) @@ -298,7 +380,9 @@ public function setTotalAmount($total_amount) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -308,7 +392,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -318,8 +404,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -333,7 +421,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -343,16 +433,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPlanResponse.php b/src/Model/BillingPlanResponse.php index 66136d91..f68e6875 100644 --- a/src/Model/BillingPlanResponse.php +++ b/src/Model/BillingPlanResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPlanResponse Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPlanResponse implements ArrayAccess +class BillingPlanResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPlanResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,40 @@ class BillingPlanResponse implements ArrayAccess 'successor_plans' => '\DocuSign\eSign\Model\BillingPlan[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'billing_plan' => null, + 'successor_plans' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -73,9 +103,9 @@ public static function swaggerTypes() 'successor_plans' => 'successorPlans' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -83,9 +113,9 @@ public static function swaggerTypes() 'successor_plans' => 'setSuccessorPlans' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -93,34 +123,63 @@ public static function swaggerTypes() 'successor_plans' => 'getSuccessorPlans' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -129,30 +188,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets billing_plan + * * @return \DocuSign\eSign\Model\BillingPlan */ public function getBillingPlan() @@ -162,7 +223,9 @@ public function getBillingPlan() /** * Sets billing_plan - * @param \DocuSign\eSign\Model\BillingPlan $billing_plan + * + * @param \DocuSign\eSign\Model\BillingPlan $billing_plan billing_plan + * * @return $this */ public function setBillingPlan($billing_plan) @@ -174,6 +237,7 @@ public function setBillingPlan($billing_plan) /** * Gets successor_plans + * * @return \DocuSign\eSign\Model\BillingPlan[] */ public function getSuccessorPlans() @@ -183,7 +247,9 @@ public function getSuccessorPlans() /** * Sets successor_plans + * * @param \DocuSign\eSign\Model\BillingPlan[] $successor_plans + * * @return $this */ public function setSuccessorPlans($successor_plans) @@ -194,7 +260,9 @@ public function setSuccessorPlans($successor_plans) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -204,7 +272,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -214,8 +284,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -229,7 +301,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -239,16 +313,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPlanUpdateResponse.php b/src/Model/BillingPlanUpdateResponse.php index e722622b..d89d5ccc 100644 --- a/src/Model/BillingPlanUpdateResponse.php +++ b/src/Model/BillingPlanUpdateResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPlanUpdateResponse Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPlanUpdateResponse implements ArrayAccess +class BillingPlanUpdateResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPlanUpdateResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,46 @@ class BillingPlanUpdateResponse implements ArrayAccess 'plan_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_payment_method' => null, + 'billing_plan_preview' => null, + 'currency_code' => null, + 'included_seats' => null, + 'payment_cycle' => null, + 'payment_method' => null, + 'plan_id' => null, + 'plan_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -85,9 +121,9 @@ public static function swaggerTypes() 'plan_name' => 'planName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -101,9 +137,9 @@ public static function swaggerTypes() 'plan_name' => 'setPlanName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -117,34 +153,63 @@ public static function swaggerTypes() 'plan_name' => 'getPlanName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -159,30 +224,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_payment_method + * * @return string */ public function getAccountPaymentMethod() @@ -192,7 +259,9 @@ public function getAccountPaymentMethod() /** * Sets account_payment_method + * * @param string $account_payment_method + * * @return $this */ public function setAccountPaymentMethod($account_payment_method) @@ -204,6 +273,7 @@ public function setAccountPaymentMethod($account_payment_method) /** * Gets billing_plan_preview + * * @return \DocuSign\eSign\Model\BillingPlanPreview */ public function getBillingPlanPreview() @@ -213,7 +283,9 @@ public function getBillingPlanPreview() /** * Sets billing_plan_preview - * @param \DocuSign\eSign\Model\BillingPlanPreview $billing_plan_preview + * + * @param \DocuSign\eSign\Model\BillingPlanPreview $billing_plan_preview billing_plan_preview + * * @return $this */ public function setBillingPlanPreview($billing_plan_preview) @@ -225,6 +297,7 @@ public function setBillingPlanPreview($billing_plan_preview) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -234,7 +307,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code Specifies the ISO currency code for the account. + * * @return $this */ public function setCurrencyCode($currency_code) @@ -246,6 +321,7 @@ public function setCurrencyCode($currency_code) /** * Gets included_seats + * * @return string */ public function getIncludedSeats() @@ -255,7 +331,9 @@ public function getIncludedSeats() /** * Sets included_seats + * * @param string $included_seats The number of seats (users) included. + * * @return $this */ public function setIncludedSeats($included_seats) @@ -267,6 +345,7 @@ public function setIncludedSeats($included_seats) /** * Gets payment_cycle + * * @return string */ public function getPaymentCycle() @@ -276,7 +355,9 @@ public function getPaymentCycle() /** * Sets payment_cycle + * * @param string $payment_cycle + * * @return $this */ public function setPaymentCycle($payment_cycle) @@ -288,6 +369,7 @@ public function setPaymentCycle($payment_cycle) /** * Gets payment_method + * * @return string */ public function getPaymentMethod() @@ -297,7 +379,9 @@ public function getPaymentMethod() /** * Sets payment_method + * * @param string $payment_method + * * @return $this */ public function setPaymentMethod($payment_method) @@ -309,6 +393,7 @@ public function setPaymentMethod($payment_method) /** * Gets plan_id + * * @return string */ public function getPlanId() @@ -318,7 +403,9 @@ public function getPlanId() /** * Sets plan_id + * * @param string $plan_id + * * @return $this */ public function setPlanId($plan_id) @@ -330,6 +417,7 @@ public function setPlanId($plan_id) /** * Gets plan_name + * * @return string */ public function getPlanName() @@ -339,7 +427,9 @@ public function getPlanName() /** * Sets plan_name + * * @param string $plan_name + * * @return $this */ public function setPlanName($plan_name) @@ -350,7 +440,9 @@ public function setPlanName($plan_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -360,7 +452,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -370,8 +464,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -385,7 +481,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -395,16 +493,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPlansResponse.php b/src/Model/BillingPlansResponse.php index dcad1c15..f839445d 100644 --- a/src/Model/BillingPlansResponse.php +++ b/src/Model/BillingPlansResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPlansResponse Class Doc Comment @@ -40,83 +41,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPlansResponse implements ArrayAccess +class BillingPlansResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPlansResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'billing_plans' => '\DocuSign\eSign\Model\BillingPlan[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'billing_plans' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'billing_plans' => 'billingPlans' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'billing_plans' => 'setBillingPlans' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'billing_plans' => 'getBillingPlans' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -124,30 +182,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets billing_plans + * * @return \DocuSign\eSign\Model\BillingPlan[] */ public function getBillingPlans() @@ -157,7 +217,9 @@ public function getBillingPlans() /** * Sets billing_plans + * * @param \DocuSign\eSign\Model\BillingPlan[] $billing_plans Reserved: TBD + * * @return $this */ public function setBillingPlans($billing_plans) @@ -168,7 +230,9 @@ public function setBillingPlans($billing_plans) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -178,7 +242,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -188,8 +254,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -203,7 +271,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -213,16 +283,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BillingPrice.php b/src/Model/BillingPrice.php index d0c0cb76..42f18806 100644 --- a/src/Model/BillingPrice.php +++ b/src/Model/BillingPrice.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BillingPrice Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BillingPrice implements ArrayAccess +class BillingPrice implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'billingPrice'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class BillingPrice implements ArrayAccess 'unit_price' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'begin_quantity' => null, + 'end_quantity' => null, + 'unit_price' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'unit_price' => 'unitPrice' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'unit_price' => 'setUnitPrice' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'unit_price' => 'getUnitPrice' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets begin_quantity + * * @return string */ public function getBeginQuantity() @@ -166,7 +228,9 @@ public function getBeginQuantity() /** * Sets begin_quantity + * * @param string $begin_quantity Reserved: TBD + * * @return $this */ public function setBeginQuantity($begin_quantity) @@ -178,6 +242,7 @@ public function setBeginQuantity($begin_quantity) /** * Gets end_quantity + * * @return string */ public function getEndQuantity() @@ -187,7 +252,9 @@ public function getEndQuantity() /** * Sets end_quantity + * * @param string $end_quantity + * * @return $this */ public function setEndQuantity($end_quantity) @@ -199,6 +266,7 @@ public function setEndQuantity($end_quantity) /** * Gets unit_price + * * @return string */ public function getUnitPrice() @@ -208,7 +276,9 @@ public function getUnitPrice() /** * Sets unit_price + * * @param string $unit_price Reserved: TBD + * * @return $this */ public function setUnitPrice($unit_price) @@ -219,7 +289,9 @@ public function setUnitPrice($unit_price) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Brand.php b/src/Model/Brand.php index fbd69059..16f869ea 100644 --- a/src/Model/Brand.php +++ b/src/Model/Brand.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Brand Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Brand implements ArrayAccess +class Brand implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brand'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -71,13 +74,53 @@ class Brand implements ArrayAccess 'resources' => '\DocuSign\eSign\Model\BrandResourceUrls' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'brand_company' => null, + 'brand_id' => null, + 'brand_languages' => null, + 'brand_name' => null, + 'colors' => null, + 'default_brand_language' => null, + 'email_content' => null, + 'error_details' => null, + 'is_overriding_company_name' => null, + 'is_sending_default' => null, + 'is_signing_default' => null, + 'landing_pages' => null, + 'links' => null, + 'logos' => null, + 'resources' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -98,9 +141,9 @@ public static function swaggerTypes() 'resources' => 'resources' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -121,9 +164,9 @@ public static function swaggerTypes() 'resources' => 'setResources' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -144,34 +187,63 @@ public static function swaggerTypes() 'resources' => 'getResources' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -193,30 +265,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets brand_company + * * @return string */ public function getBrandCompany() @@ -226,7 +300,9 @@ public function getBrandCompany() /** * Sets brand_company + * * @param string $brand_company The name of the company associated with this brand. + * * @return $this */ public function setBrandCompany($brand_company) @@ -238,6 +314,7 @@ public function setBrandCompany($brand_company) /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -247,7 +324,9 @@ public function getBrandId() /** * Sets brand_id + * * @param string $brand_id The ID used to identify a specific brand in API calls. + * * @return $this */ public function setBrandId($brand_id) @@ -259,6 +338,7 @@ public function setBrandId($brand_id) /** * Gets brand_languages + * * @return string[] */ public function getBrandLanguages() @@ -268,7 +348,9 @@ public function getBrandLanguages() /** * Sets brand_languages + * * @param string[] $brand_languages + * * @return $this */ public function setBrandLanguages($brand_languages) @@ -280,6 +362,7 @@ public function setBrandLanguages($brand_languages) /** * Gets brand_name + * * @return string */ public function getBrandName() @@ -289,7 +372,9 @@ public function getBrandName() /** * Sets brand_name + * * @param string $brand_name The name of the brand. + * * @return $this */ public function setBrandName($brand_name) @@ -301,6 +386,7 @@ public function setBrandName($brand_name) /** * Gets colors + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getColors() @@ -310,7 +396,9 @@ public function getColors() /** * Sets colors + * * @param \DocuSign\eSign\Model\NameValue[] $colors + * * @return $this */ public function setColors($colors) @@ -322,6 +410,7 @@ public function setColors($colors) /** * Gets default_brand_language + * * @return string */ public function getDefaultBrandLanguage() @@ -331,7 +420,9 @@ public function getDefaultBrandLanguage() /** * Sets default_brand_language + * * @param string $default_brand_language + * * @return $this */ public function setDefaultBrandLanguage($default_brand_language) @@ -343,6 +434,7 @@ public function setDefaultBrandLanguage($default_brand_language) /** * Gets email_content + * * @return \DocuSign\eSign\Model\BrandEmailContent[] */ public function getEmailContent() @@ -352,7 +444,9 @@ public function getEmailContent() /** * Sets email_content + * * @param \DocuSign\eSign\Model\BrandEmailContent[] $email_content + * * @return $this */ public function setEmailContent($email_content) @@ -364,6 +458,7 @@ public function setEmailContent($email_content) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -373,7 +468,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -385,6 +482,7 @@ public function setErrorDetails($error_details) /** * Gets is_overriding_company_name + * * @return bool */ public function getIsOverridingCompanyName() @@ -394,7 +492,9 @@ public function getIsOverridingCompanyName() /** * Sets is_overriding_company_name + * * @param bool $is_overriding_company_name + * * @return $this */ public function setIsOverridingCompanyName($is_overriding_company_name) @@ -406,6 +506,7 @@ public function setIsOverridingCompanyName($is_overriding_company_name) /** * Gets is_sending_default + * * @return bool */ public function getIsSendingDefault() @@ -415,7 +516,9 @@ public function getIsSendingDefault() /** * Sets is_sending_default + * * @param bool $is_sending_default + * * @return $this */ public function setIsSendingDefault($is_sending_default) @@ -427,6 +530,7 @@ public function setIsSendingDefault($is_sending_default) /** * Gets is_signing_default + * * @return bool */ public function getIsSigningDefault() @@ -436,7 +540,9 @@ public function getIsSigningDefault() /** * Sets is_signing_default + * * @param bool $is_signing_default + * * @return $this */ public function setIsSigningDefault($is_signing_default) @@ -448,6 +554,7 @@ public function setIsSigningDefault($is_signing_default) /** * Gets landing_pages + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getLandingPages() @@ -457,7 +564,9 @@ public function getLandingPages() /** * Sets landing_pages + * * @param \DocuSign\eSign\Model\NameValue[] $landing_pages + * * @return $this */ public function setLandingPages($landing_pages) @@ -469,6 +578,7 @@ public function setLandingPages($landing_pages) /** * Gets links + * * @return \DocuSign\eSign\Model\BrandLink[] */ public function getLinks() @@ -478,7 +588,9 @@ public function getLinks() /** * Sets links + * * @param \DocuSign\eSign\Model\BrandLink[] $links + * * @return $this */ public function setLinks($links) @@ -490,6 +602,7 @@ public function setLinks($links) /** * Gets logos + * * @return \DocuSign\eSign\Model\BrandLogos */ public function getLogos() @@ -499,7 +612,9 @@ public function getLogos() /** * Sets logos - * @param \DocuSign\eSign\Model\BrandLogos $logos + * + * @param \DocuSign\eSign\Model\BrandLogos $logos logos + * * @return $this */ public function setLogos($logos) @@ -511,6 +626,7 @@ public function setLogos($logos) /** * Gets resources + * * @return \DocuSign\eSign\Model\BrandResourceUrls */ public function getResources() @@ -520,7 +636,9 @@ public function getResources() /** * Sets resources - * @param \DocuSign\eSign\Model\BrandResourceUrls $resources + * + * @param \DocuSign\eSign\Model\BrandResourceUrls $resources resources + * * @return $this */ public function setResources($resources) @@ -531,7 +649,9 @@ public function setResources($resources) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -541,7 +661,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -551,8 +673,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -566,7 +690,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -576,16 +702,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BrandEmailContent.php b/src/Model/BrandEmailContent.php index 8b140c24..a09f28fd 100644 --- a/src/Model/BrandEmailContent.php +++ b/src/Model/BrandEmailContent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BrandEmailContent Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BrandEmailContent implements ArrayAccess +class BrandEmailContent implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brandEmailContent'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class BrandEmailContent implements ArrayAccess 'link_text' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'content' => null, + 'email_content_type' => null, + 'email_to_link' => null, + 'link_text' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'link_text' => 'linkText' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'link_text' => 'setLinkText' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'link_text' => 'getLinkText' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets content + * * @return string */ public function getContent() @@ -171,7 +234,9 @@ public function getContent() /** * Sets content + * * @param string $content + * * @return $this */ public function setContent($content) @@ -183,6 +248,7 @@ public function setContent($content) /** * Gets email_content_type + * * @return string */ public function getEmailContentType() @@ -192,7 +258,9 @@ public function getEmailContentType() /** * Sets email_content_type + * * @param string $email_content_type + * * @return $this */ public function setEmailContentType($email_content_type) @@ -204,6 +272,7 @@ public function setEmailContentType($email_content_type) /** * Gets email_to_link + * * @return string */ public function getEmailToLink() @@ -213,7 +282,9 @@ public function getEmailToLink() /** * Sets email_to_link + * * @param string $email_to_link + * * @return $this */ public function setEmailToLink($email_to_link) @@ -225,6 +296,7 @@ public function setEmailToLink($email_to_link) /** * Gets link_text + * * @return string */ public function getLinkText() @@ -234,7 +306,9 @@ public function getLinkText() /** * Sets link_text + * * @param string $link_text + * * @return $this */ public function setLinkText($link_text) @@ -245,7 +319,9 @@ public function setLinkText($link_text) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BrandLink.php b/src/Model/BrandLink.php index f64acbb1..52daf1d3 100644 --- a/src/Model/BrandLink.php +++ b/src/Model/BrandLink.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BrandLink Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BrandLink implements ArrayAccess +class BrandLink implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brandLink'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class BrandLink implements ArrayAccess 'url_or_mail_to' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'link_text' => null, + 'link_type' => null, + 'show_link' => null, + 'url_or_mail_to' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'url_or_mail_to' => 'urlOrMailTo' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'url_or_mail_to' => 'setUrlOrMailTo' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'url_or_mail_to' => 'getUrlOrMailTo' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets link_text + * * @return string */ public function getLinkText() @@ -171,7 +234,9 @@ public function getLinkText() /** * Sets link_text + * * @param string $link_text + * * @return $this */ public function setLinkText($link_text) @@ -183,6 +248,7 @@ public function setLinkText($link_text) /** * Gets link_type + * * @return string */ public function getLinkType() @@ -192,7 +258,9 @@ public function getLinkType() /** * Sets link_type + * * @param string $link_type + * * @return $this */ public function setLinkType($link_type) @@ -204,6 +272,7 @@ public function setLinkType($link_type) /** * Gets show_link + * * @return string */ public function getShowLink() @@ -213,7 +282,9 @@ public function getShowLink() /** * Sets show_link + * * @param string $show_link + * * @return $this */ public function setShowLink($show_link) @@ -225,6 +296,7 @@ public function setShowLink($show_link) /** * Gets url_or_mail_to + * * @return string */ public function getUrlOrMailTo() @@ -234,7 +306,9 @@ public function getUrlOrMailTo() /** * Sets url_or_mail_to + * * @param string $url_or_mail_to + * * @return $this */ public function setUrlOrMailTo($url_or_mail_to) @@ -245,7 +319,9 @@ public function setUrlOrMailTo($url_or_mail_to) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BrandLogos.php b/src/Model/BrandLogos.php index e7243f67..32e3bfd6 100644 --- a/src/Model/BrandLogos.php +++ b/src/Model/BrandLogos.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BrandLogos Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BrandLogos implements ArrayAccess +class BrandLogos implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brandLogos'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class BrandLogos implements ArrayAccess 'secondary' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'email' => null, + 'primary' => null, + 'secondary' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'secondary' => 'secondary' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'secondary' => 'setSecondary' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'secondary' => 'getSecondary' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets email + * * @return string */ public function getEmail() @@ -166,7 +228,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -178,6 +242,7 @@ public function setEmail($email) /** * Gets primary + * * @return string */ public function getPrimary() @@ -187,7 +252,9 @@ public function getPrimary() /** * Sets primary + * * @param string $primary + * * @return $this */ public function setPrimary($primary) @@ -199,6 +266,7 @@ public function setPrimary($primary) /** * Gets secondary + * * @return string */ public function getSecondary() @@ -208,7 +276,9 @@ public function getSecondary() /** * Sets secondary + * * @param string $secondary + * * @return $this */ public function setSecondary($secondary) @@ -219,7 +289,9 @@ public function setSecondary($secondary) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BrandRequest.php b/src/Model/BrandRequest.php index 26c6623d..de40c6bd 100644 --- a/src/Model/BrandRequest.php +++ b/src/Model/BrandRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BrandRequest Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BrandRequest implements ArrayAccess +class BrandRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brandRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'brand_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'brand_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'brand_id' => 'brandId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'brand_id' => 'setBrandId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'brand_id' => 'getBrandId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -156,7 +216,9 @@ public function getBrandId() /** * Sets brand_id + * * @param string $brand_id The ID of the brand used in API calls + * * @return $this */ public function setBrandId($brand_id) @@ -167,7 +229,9 @@ public function setBrandId($brand_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BrandResourceUrls.php b/src/Model/BrandResourceUrls.php index 2ae0242a..0829da9a 100644 --- a/src/Model/BrandResourceUrls.php +++ b/src/Model/BrandResourceUrls.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BrandResourceUrls Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BrandResourceUrls implements ArrayAccess +class BrandResourceUrls implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brandResourceUrls'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class BrandResourceUrls implements ArrayAccess 'signing_captive' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'email' => null, + 'sending' => null, + 'signing' => null, + 'signing_captive' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'signing_captive' => 'signingCaptive' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'signing_captive' => 'setSigningCaptive' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'signing_captive' => 'getSigningCaptive' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets email + * * @return string */ public function getEmail() @@ -171,7 +234,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -183,6 +248,7 @@ public function setEmail($email) /** * Gets sending + * * @return string */ public function getSending() @@ -192,7 +258,9 @@ public function getSending() /** * Sets sending + * * @param string $sending + * * @return $this */ public function setSending($sending) @@ -204,6 +272,7 @@ public function setSending($sending) /** * Gets signing + * * @return string */ public function getSigning() @@ -213,7 +282,9 @@ public function getSigning() /** * Sets signing + * * @param string $signing + * * @return $this */ public function setSigning($signing) @@ -225,6 +296,7 @@ public function setSigning($signing) /** * Gets signing_captive + * * @return string */ public function getSigningCaptive() @@ -234,7 +306,9 @@ public function getSigningCaptive() /** * Sets signing_captive + * * @param string $signing_captive + * * @return $this */ public function setSigningCaptive($signing_captive) @@ -245,7 +319,9 @@ public function setSigningCaptive($signing_captive) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BrandResources.php b/src/Model/BrandResources.php index 27422366..6bef0a5a 100644 --- a/src/Model/BrandResources.php +++ b/src/Model/BrandResources.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BrandResources Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BrandResources implements ArrayAccess +class BrandResources implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brandResources'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class BrandResources implements ArrayAccess 'resources_content_uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'created_by_user_info' => null, + 'created_date' => null, + 'data_not_saved_not_in_master' => null, + 'modified_by_user_info' => null, + 'modified_date' => null, + 'modified_templates' => null, + 'resources_content_type' => null, + 'resources_content_uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'resources_content_uri' => 'resourcesContentUri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'resources_content_uri' => 'setResourcesContentUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'resources_content_uri' => 'getResourcesContentUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets created_by_user_info + * * @return \DocuSign\eSign\Model\UserInfo */ public function getCreatedByUserInfo() @@ -191,7 +258,9 @@ public function getCreatedByUserInfo() /** * Sets created_by_user_info - * @param \DocuSign\eSign\Model\UserInfo $created_by_user_info + * + * @param \DocuSign\eSign\Model\UserInfo $created_by_user_info created_by_user_info + * * @return $this */ public function setCreatedByUserInfo($created_by_user_info) @@ -203,6 +272,7 @@ public function setCreatedByUserInfo($created_by_user_info) /** * Gets created_date + * * @return string */ public function getCreatedDate() @@ -212,7 +282,9 @@ public function getCreatedDate() /** * Sets created_date + * * @param string $created_date + * * @return $this */ public function setCreatedDate($created_date) @@ -224,6 +296,7 @@ public function setCreatedDate($created_date) /** * Gets data_not_saved_not_in_master + * * @return string[] */ public function getDataNotSavedNotInMaster() @@ -233,7 +306,9 @@ public function getDataNotSavedNotInMaster() /** * Sets data_not_saved_not_in_master + * * @param string[] $data_not_saved_not_in_master + * * @return $this */ public function setDataNotSavedNotInMaster($data_not_saved_not_in_master) @@ -245,6 +320,7 @@ public function setDataNotSavedNotInMaster($data_not_saved_not_in_master) /** * Gets modified_by_user_info + * * @return \DocuSign\eSign\Model\UserInfo */ public function getModifiedByUserInfo() @@ -254,7 +330,9 @@ public function getModifiedByUserInfo() /** * Sets modified_by_user_info - * @param \DocuSign\eSign\Model\UserInfo $modified_by_user_info + * + * @param \DocuSign\eSign\Model\UserInfo $modified_by_user_info modified_by_user_info + * * @return $this */ public function setModifiedByUserInfo($modified_by_user_info) @@ -266,6 +344,7 @@ public function setModifiedByUserInfo($modified_by_user_info) /** * Gets modified_date + * * @return string */ public function getModifiedDate() @@ -275,7 +354,9 @@ public function getModifiedDate() /** * Sets modified_date + * * @param string $modified_date + * * @return $this */ public function setModifiedDate($modified_date) @@ -287,6 +368,7 @@ public function setModifiedDate($modified_date) /** * Gets modified_templates + * * @return string[] */ public function getModifiedTemplates() @@ -296,7 +378,9 @@ public function getModifiedTemplates() /** * Sets modified_templates + * * @param string[] $modified_templates + * * @return $this */ public function setModifiedTemplates($modified_templates) @@ -308,6 +392,7 @@ public function setModifiedTemplates($modified_templates) /** * Gets resources_content_type + * * @return string */ public function getResourcesContentType() @@ -317,7 +402,9 @@ public function getResourcesContentType() /** * Sets resources_content_type + * * @param string $resources_content_type + * * @return $this */ public function setResourcesContentType($resources_content_type) @@ -329,6 +416,7 @@ public function setResourcesContentType($resources_content_type) /** * Gets resources_content_uri + * * @return string */ public function getResourcesContentUri() @@ -338,7 +426,9 @@ public function getResourcesContentUri() /** * Sets resources_content_uri + * * @param string $resources_content_uri + * * @return $this */ public function setResourcesContentUri($resources_content_uri) @@ -349,7 +439,9 @@ public function setResourcesContentUri($resources_content_uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BrandResourcesList.php b/src/Model/BrandResourcesList.php index ee7641d0..a1f68714 100644 --- a/src/Model/BrandResourcesList.php +++ b/src/Model/BrandResourcesList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BrandResourcesList Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BrandResourcesList implements ArrayAccess +class BrandResourcesList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brandResourcesList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'resources_content_types' => '\DocuSign\eSign\Model\BrandResources[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'resources_content_types' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'resources_content_types' => 'resourcesContentTypes' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'resources_content_types' => 'setResourcesContentTypes' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'resources_content_types' => 'getResourcesContentTypes' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets resources_content_types + * * @return \DocuSign\eSign\Model\BrandResources[] */ public function getResourcesContentTypes() @@ -156,7 +216,9 @@ public function getResourcesContentTypes() /** * Sets resources_content_types + * * @param \DocuSign\eSign\Model\BrandResources[] $resources_content_types + * * @return $this */ public function setResourcesContentTypes($resources_content_types) @@ -167,7 +229,9 @@ public function setResourcesContentTypes($resources_content_types) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BrandsRequest.php b/src/Model/BrandsRequest.php index 24360308..fb93a78c 100644 --- a/src/Model/BrandsRequest.php +++ b/src/Model/BrandsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BrandsRequest Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BrandsRequest implements ArrayAccess +class BrandsRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brandsRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'brands' => '\DocuSign\eSign\Model\BrandRequest[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'brands' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'brands' => 'brands' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'brands' => 'setBrands' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'brands' => 'getBrands' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets brands + * * @return \DocuSign\eSign\Model\BrandRequest[] */ public function getBrands() @@ -156,7 +216,9 @@ public function getBrands() /** * Sets brands + * * @param \DocuSign\eSign\Model\BrandRequest[] $brands The list of brands. + * * @return $this */ public function setBrands($brands) @@ -167,7 +229,9 @@ public function setBrands($brands) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BrandsResponse.php b/src/Model/BrandsResponse.php index e6dad59b..83db5358 100644 --- a/src/Model/BrandsResponse.php +++ b/src/Model/BrandsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BrandsResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BrandsResponse implements ArrayAccess +class BrandsResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'brandsResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class BrandsResponse implements ArrayAccess 'sender_brand_id_default' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'brands' => null, + 'recipient_brand_id_default' => null, + 'sender_brand_id_default' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'sender_brand_id_default' => 'senderBrandIdDefault' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'sender_brand_id_default' => 'setSenderBrandIdDefault' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'sender_brand_id_default' => 'getSenderBrandIdDefault' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets brands + * * @return \DocuSign\eSign\Model\Brand[] */ public function getBrands() @@ -166,7 +228,9 @@ public function getBrands() /** * Sets brands + * * @param \DocuSign\eSign\Model\Brand[] $brands The list of brands. + * * @return $this */ public function setBrands($brands) @@ -178,6 +242,7 @@ public function setBrands($brands) /** * Gets recipient_brand_id_default + * * @return string */ public function getRecipientBrandIdDefault() @@ -187,7 +252,9 @@ public function getRecipientBrandIdDefault() /** * Sets recipient_brand_id_default + * * @param string $recipient_brand_id_default The brand seen by envelope recipients when a brand is not explicitly set. + * * @return $this */ public function setRecipientBrandIdDefault($recipient_brand_id_default) @@ -199,6 +266,7 @@ public function setRecipientBrandIdDefault($recipient_brand_id_default) /** * Gets sender_brand_id_default + * * @return string */ public function getSenderBrandIdDefault() @@ -208,7 +276,9 @@ public function getSenderBrandIdDefault() /** * Sets sender_brand_id_default + * * @param string $sender_brand_id_default The brand seen by envelope senders when a brand is not explicitly set. + * * @return $this */ public function setSenderBrandIdDefault($sender_brand_id_default) @@ -219,7 +289,9 @@ public function setSenderBrandIdDefault($sender_brand_id_default) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkEnvelope.php b/src/Model/BulkEnvelope.php index 7945fa1b..b4beccf3 100644 --- a/src/Model/BulkEnvelope.php +++ b/src/Model/BulkEnvelope.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkEnvelope Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkEnvelope implements ArrayAccess +class BulkEnvelope implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkEnvelope'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,47 @@ class BulkEnvelope implements ArrayAccess 'transaction_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_recipient_row' => null, + 'bulk_status' => null, + 'email' => null, + 'envelope_id' => null, + 'envelope_uri' => null, + 'error_details' => null, + 'name' => null, + 'submitted_date_time' => null, + 'transaction_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -86,9 +123,9 @@ public static function swaggerTypes() 'transaction_id' => 'transactionId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -103,9 +140,9 @@ public static function swaggerTypes() 'transaction_id' => 'setTransactionId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -120,34 +157,63 @@ public static function swaggerTypes() 'transaction_id' => 'getTransactionId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -163,30 +229,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_recipient_row + * * @return string */ public function getBulkRecipientRow() @@ -196,7 +264,9 @@ public function getBulkRecipientRow() /** * Sets bulk_recipient_row + * * @param string $bulk_recipient_row Reserved: TBD + * * @return $this */ public function setBulkRecipientRow($bulk_recipient_row) @@ -208,6 +278,7 @@ public function setBulkRecipientRow($bulk_recipient_row) /** * Gets bulk_status + * * @return string */ public function getBulkStatus() @@ -217,7 +288,9 @@ public function getBulkStatus() /** * Sets bulk_status + * * @param string $bulk_status Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed + * * @return $this */ public function setBulkStatus($bulk_status) @@ -229,6 +302,7 @@ public function setBulkStatus($bulk_status) /** * Gets email + * * @return string */ public function getEmail() @@ -238,7 +312,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -250,6 +326,7 @@ public function setEmail($email) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -259,7 +336,9 @@ public function getEnvelopeId() /** * 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) @@ -271,6 +350,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -280,7 +360,9 @@ public function getEnvelopeUri() /** * Sets envelope_uri + * * @param string $envelope_uri Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. + * * @return $this */ public function setEnvelopeUri($envelope_uri) @@ -292,6 +374,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -301,7 +384,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -313,6 +398,7 @@ public function setErrorDetails($error_details) /** * Gets name + * * @return string */ public function getName() @@ -322,7 +408,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -334,6 +422,7 @@ public function setName($name) /** * Gets submitted_date_time + * * @return string */ public function getSubmittedDateTime() @@ -343,7 +432,9 @@ public function getSubmittedDateTime() /** * Sets submitted_date_time + * * @param string $submitted_date_time + * * @return $this */ public function setSubmittedDateTime($submitted_date_time) @@ -355,6 +446,7 @@ public function setSubmittedDateTime($submitted_date_time) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -364,7 +456,9 @@ public function getTransactionId() /** * 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) @@ -375,7 +469,9 @@ public function setTransactionId($transaction_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -385,7 +481,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -395,8 +493,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -410,7 +510,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -420,16 +522,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkEnvelopeStatus.php b/src/Model/BulkEnvelopeStatus.php index 72a06871..9f9fa3f4 100644 --- a/src/Model/BulkEnvelopeStatus.php +++ b/src/Model/BulkEnvelopeStatus.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkEnvelopeStatus Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkEnvelopeStatus implements ArrayAccess +class BulkEnvelopeStatus implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkEnvelopeStatus'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -70,13 +73,52 @@ class BulkEnvelopeStatus implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'batch_id' => null, + 'batch_size' => null, + 'bulk_envelopes' => null, + 'bulk_envelopes_batch_uri' => null, + 'end_position' => null, + 'failed' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'queued' => null, + 'result_set_size' => null, + 'sent' => null, + 'start_position' => null, + 'submitted_date' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -96,9 +138,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -118,9 +160,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -140,34 +182,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -188,30 +259,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets batch_id + * * @return string */ public function getBatchId() @@ -221,7 +294,9 @@ public function getBatchId() /** * Sets batch_id + * * @param string $batch_id Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches. + * * @return $this */ public function setBatchId($batch_id) @@ -233,6 +308,7 @@ public function setBatchId($batch_id) /** * Gets batch_size + * * @return string */ public function getBatchSize() @@ -242,7 +318,9 @@ public function getBatchSize() /** * Sets batch_size + * * @param string $batch_size The number of items returned in this response. + * * @return $this */ public function setBatchSize($batch_size) @@ -254,6 +332,7 @@ public function setBatchSize($batch_size) /** * Gets bulk_envelopes + * * @return \DocuSign\eSign\Model\BulkEnvelope[] */ public function getBulkEnvelopes() @@ -263,7 +342,9 @@ public function getBulkEnvelopes() /** * Sets bulk_envelopes + * * @param \DocuSign\eSign\Model\BulkEnvelope[] $bulk_envelopes Reserved: TBD + * * @return $this */ public function setBulkEnvelopes($bulk_envelopes) @@ -275,6 +356,7 @@ public function setBulkEnvelopes($bulk_envelopes) /** * Gets bulk_envelopes_batch_uri + * * @return string */ public function getBulkEnvelopesBatchUri() @@ -284,7 +366,9 @@ public function getBulkEnvelopesBatchUri() /** * Sets bulk_envelopes_batch_uri + * * @param string $bulk_envelopes_batch_uri Reserved: TBD + * * @return $this */ public function setBulkEnvelopesBatchUri($bulk_envelopes_batch_uri) @@ -296,6 +380,7 @@ public function setBulkEnvelopesBatchUri($bulk_envelopes_batch_uri) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -305,7 +390,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -317,6 +404,7 @@ public function setEndPosition($end_position) /** * Gets failed + * * @return string */ public function getFailed() @@ -326,7 +414,9 @@ public function getFailed() /** * Sets failed + * * @param string $failed The number of entries with a status of failed. + * * @return $this */ public function setFailed($failed) @@ -338,6 +428,7 @@ public function setFailed($failed) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -347,7 +438,9 @@ public function getNextUri() /** * 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) @@ -359,6 +452,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -368,7 +462,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -380,6 +476,7 @@ public function setPreviousUri($previous_uri) /** * Gets queued + * * @return string */ public function getQueued() @@ -389,7 +486,9 @@ public function getQueued() /** * Sets queued + * * @param string $queued The number of entries with a status of queued. + * * @return $this */ public function setQueued($queued) @@ -401,6 +500,7 @@ public function setQueued($queued) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -410,7 +510,9 @@ public function getResultSetSize() /** * 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) @@ -422,6 +524,7 @@ public function setResultSetSize($result_set_size) /** * Gets sent + * * @return string */ public function getSent() @@ -431,7 +534,9 @@ public function getSent() /** * Sets sent + * * @param string $sent The number of entries with a status of sent. + * * @return $this */ public function setSent($sent) @@ -443,6 +548,7 @@ public function setSent($sent) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -452,7 +558,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -464,6 +572,7 @@ public function setStartPosition($start_position) /** * Gets submitted_date + * * @return string */ public function getSubmittedDate() @@ -473,7 +582,9 @@ public function getSubmittedDate() /** * Sets submitted_date + * * @param string $submitted_date + * * @return $this */ public function setSubmittedDate($submitted_date) @@ -485,6 +596,7 @@ public function setSubmittedDate($submitted_date) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -494,7 +606,9 @@ public function getTotalSetSize() /** * 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) @@ -505,7 +619,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -515,7 +631,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -525,8 +643,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -540,7 +660,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -550,16 +672,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkEnvelopesResponse.php b/src/Model/BulkEnvelopesResponse.php index abc7252e..ee3712b8 100644 --- a/src/Model/BulkEnvelopesResponse.php +++ b/src/Model/BulkEnvelopesResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkEnvelopesResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkEnvelopesResponse implements ArrayAccess +class BulkEnvelopesResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkEnvelopesResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class BulkEnvelopesResponse implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_envelope_statuses' => null, + 'end_position' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_envelope_statuses + * * @return \DocuSign\eSign\Model\BulkEnvelopeStatus[] */ public function getBulkEnvelopeStatuses() @@ -186,7 +252,9 @@ public function getBulkEnvelopeStatuses() /** * Sets bulk_envelope_statuses + * * @param \DocuSign\eSign\Model\BulkEnvelopeStatus[] $bulk_envelope_statuses Reserved: TBD + * * @return $this */ public function setBulkEnvelopeStatuses($bulk_envelope_statuses) @@ -198,6 +266,7 @@ public function setBulkEnvelopeStatuses($bulk_envelope_statuses) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -207,7 +276,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -219,6 +290,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -228,7 +300,9 @@ public function getNextUri() /** * 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) @@ -240,6 +314,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkRecipient.php b/src/Model/BulkRecipient.php index 861b1609..6c672df6 100644 --- a/src/Model/BulkRecipient.php +++ b/src/Model/BulkRecipient.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkRecipient Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkRecipient implements ArrayAccess +class BulkRecipient implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkRecipient'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class BulkRecipient implements ArrayAccess 'tab_labels' => '\DocuSign\eSign\Model\BulkRecipientTabLabel[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'email' => null, + 'error_details' => null, + 'identification' => null, + 'name' => null, + 'note' => null, + 'phone_number' => null, + 'recipient_signature_provider_info' => null, + 'row_number' => null, + 'tab_labels' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'tab_labels' => 'tabLabels' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'tab_labels' => 'setTabLabels' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'tab_labels' => 'getTabLabels' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -201,7 +270,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -213,6 +284,7 @@ public function setAccessCode($access_code) /** * Gets email + * * @return string */ public function getEmail() @@ -222,7 +294,9 @@ public function getEmail() /** * Sets email + * * @param string $email Specifies the recipient's email address. Maximum length: 100 characters. + * * @return $this */ public function setEmail($email) @@ -234,6 +308,7 @@ public function setEmail($email) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails[] */ public function getErrorDetails() @@ -243,7 +318,9 @@ public function getErrorDetails() /** * Sets error_details + * * @param \DocuSign\eSign\Model\ErrorDetails[] $error_details Array or errors. + * * @return $this */ public function setErrorDetails($error_details) @@ -255,6 +332,7 @@ public function setErrorDetails($error_details) /** * Gets identification + * * @return string */ public function getIdentification() @@ -264,7 +342,9 @@ public function getIdentification() /** * Sets identification + * * @param string $identification Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field. The acceptable values are: * KBA: Enables the normal ID check authentication set up for your account. * Phone: Enables phone authentication. * SMS: Enables SMS authentication. + * * @return $this */ public function setIdentification($identification) @@ -276,6 +356,7 @@ public function setIdentification($identification) /** * Gets name + * * @return string */ public function getName() @@ -285,7 +366,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the recipient's name. Maximum length: 50 characters. + * * @return $this */ public function setName($name) @@ -297,6 +380,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -306,7 +390,9 @@ public function getNote() /** * 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) @@ -318,6 +404,7 @@ public function setNote($note) /** * Gets phone_number + * * @return string */ public function getPhoneNumber() @@ -327,7 +414,9 @@ public function getPhoneNumber() /** * Sets phone_number + * * @param string $phone_number This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number. If `usersupplied` is used, the signer supplies his or her own telephone number. + * * @return $this */ public function setPhoneNumber($phone_number) @@ -339,6 +428,7 @@ public function setPhoneNumber($phone_number) /** * Gets recipient_signature_provider_info + * * @return \DocuSign\eSign\Model\BulkRecipientSignatureProvider[] */ public function getRecipientSignatureProviderInfo() @@ -348,7 +438,9 @@ public function getRecipientSignatureProviderInfo() /** * Sets recipient_signature_provider_info + * * @param \DocuSign\eSign\Model\BulkRecipientSignatureProvider[] $recipient_signature_provider_info + * * @return $this */ public function setRecipientSignatureProviderInfo($recipient_signature_provider_info) @@ -360,6 +452,7 @@ public function setRecipientSignatureProviderInfo($recipient_signature_provider_ /** * Gets row_number + * * @return string */ public function getRowNumber() @@ -369,7 +462,9 @@ public function getRowNumber() /** * Sets row_number + * * @param string $row_number + * * @return $this */ public function setRowNumber($row_number) @@ -381,6 +476,7 @@ public function setRowNumber($row_number) /** * Gets tab_labels + * * @return \DocuSign\eSign\Model\BulkRecipientTabLabel[] */ public function getTabLabels() @@ -390,7 +486,9 @@ public function getTabLabels() /** * Sets tab_labels + * * @param \DocuSign\eSign\Model\BulkRecipientTabLabel[] $tab_labels Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file. The information used in the bulk recipient file header must be the same as the `tabLabel` for the tab. The values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row. Note that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs. + * * @return $this */ public function setTabLabels($tab_labels) @@ -401,7 +499,9 @@ public function setTabLabels($tab_labels) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkRecipientSignatureProvider.php b/src/Model/BulkRecipientSignatureProvider.php index 8a95bc67..1644479a 100644 --- a/src/Model/BulkRecipientSignatureProvider.php +++ b/src/Model/BulkRecipientSignatureProvider.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkRecipientSignatureProvider Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkRecipientSignatureProvider implements ArrayAccess +class BulkRecipientSignatureProvider implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkRecipientSignatureProvider'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class BulkRecipientSignatureProvider implements ArrayAccess 'value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'name' => null, + 'value' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'value' => 'value' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'value' => 'setValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'value' => 'getValue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets name + * * @return string */ public function getName() @@ -161,7 +222,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -173,6 +236,7 @@ public function setName($name) /** * Gets value + * * @return string */ public function getValue() @@ -182,7 +246,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -193,7 +259,9 @@ public function setValue($value) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkRecipientTabLabel.php b/src/Model/BulkRecipientTabLabel.php index ee0d204a..7ea295a5 100644 --- a/src/Model/BulkRecipientTabLabel.php +++ b/src/Model/BulkRecipientTabLabel.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkRecipientTabLabel Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkRecipientTabLabel implements ArrayAccess +class BulkRecipientTabLabel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkRecipientTabLabel'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class BulkRecipientTabLabel implements ArrayAccess 'value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'name' => null, + 'value' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'value' => 'value' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'value' => 'setValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'value' => 'getValue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets name + * * @return string */ public function getName() @@ -161,7 +222,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -173,6 +236,7 @@ public function setName($name) /** * Gets value + * * @return string */ public function getValue() @@ -182,7 +246,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -193,7 +259,9 @@ public function setValue($value) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkRecipientsRequest.php b/src/Model/BulkRecipientsRequest.php index c344d82a..fcd6372f 100644 --- a/src/Model/BulkRecipientsRequest.php +++ b/src/Model/BulkRecipientsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkRecipientsRequest Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkRecipientsRequest implements ArrayAccess +class BulkRecipientsRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkRecipientsRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'bulk_recipients' => '\DocuSign\eSign\Model\BulkRecipient[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_recipients' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'bulk_recipients' => 'bulkRecipients' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'bulk_recipients' => 'setBulkRecipients' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'bulk_recipients' => 'getBulkRecipients' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_recipients + * * @return \DocuSign\eSign\Model\BulkRecipient[] */ public function getBulkRecipients() @@ -156,7 +216,9 @@ public function getBulkRecipients() /** * Sets bulk_recipients + * * @param \DocuSign\eSign\Model\BulkRecipient[] $bulk_recipients A complex type containing information about the bulk recipients in the request. + * * @return $this */ public function setBulkRecipients($bulk_recipients) @@ -167,7 +229,9 @@ public function setBulkRecipients($bulk_recipients) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkRecipientsResponse.php b/src/Model/BulkRecipientsResponse.php index e41e5f6a..089eeb32 100644 --- a/src/Model/BulkRecipientsResponse.php +++ b/src/Model/BulkRecipientsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkRecipientsResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkRecipientsResponse implements ArrayAccess +class BulkRecipientsResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkRecipientsResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class BulkRecipientsResponse implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_recipients' => null, + 'end_position' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_recipients + * * @return \DocuSign\eSign\Model\BulkRecipient[] */ public function getBulkRecipients() @@ -186,7 +252,9 @@ public function getBulkRecipients() /** * Sets bulk_recipients + * * @param \DocuSign\eSign\Model\BulkRecipient[] $bulk_recipients A complex type containing information about the bulk recipients in the response. + * * @return $this */ public function setBulkRecipients($bulk_recipients) @@ -198,6 +266,7 @@ public function setBulkRecipients($bulk_recipients) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -207,7 +276,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -219,6 +290,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -228,7 +300,9 @@ public function getNextUri() /** * 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) @@ -240,6 +314,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkRecipientsSummaryResponse.php b/src/Model/BulkRecipientsSummaryResponse.php index a7b32af7..040b7959 100644 --- a/src/Model/BulkRecipientsSummaryResponse.php +++ b/src/Model/BulkRecipientsSummaryResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkRecipientsSummaryResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkRecipientsSummaryResponse implements ArrayAccess +class BulkRecipientsSummaryResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkRecipientsSummaryResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class BulkRecipientsSummaryResponse implements ArrayAccess 'error_details' => '\DocuSign\eSign\Model\ErrorDetails[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_recipients' => null, + 'bulk_recipients_count' => null, + 'bulk_recipients_uri' => null, + 'error_details' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'error_details' => 'errorDetails' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'error_details' => 'setErrorDetails' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'error_details' => 'getErrorDetails' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_recipients + * * @return \DocuSign\eSign\Model\BulkRecipient[] */ public function getBulkRecipients() @@ -171,7 +234,9 @@ public function getBulkRecipients() /** * Sets bulk_recipients + * * @param \DocuSign\eSign\Model\BulkRecipient[] $bulk_recipients A complex type containing information about the bulk recipients in the response. + * * @return $this */ public function setBulkRecipients($bulk_recipients) @@ -183,6 +248,7 @@ public function setBulkRecipients($bulk_recipients) /** * Gets bulk_recipients_count + * * @return string */ public function getBulkRecipientsCount() @@ -192,7 +258,9 @@ public function getBulkRecipientsCount() /** * Sets bulk_recipients_count + * * @param string $bulk_recipients_count The number of items returned in this response. + * * @return $this */ public function setBulkRecipientsCount($bulk_recipients_count) @@ -204,6 +272,7 @@ public function setBulkRecipientsCount($bulk_recipients_count) /** * Gets bulk_recipients_uri + * * @return string */ public function getBulkRecipientsUri() @@ -213,7 +282,9 @@ public function getBulkRecipientsUri() /** * 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) @@ -225,6 +296,7 @@ public function setBulkRecipientsUri($bulk_recipients_uri) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails[] */ public function getErrorDetails() @@ -234,7 +306,9 @@ public function getErrorDetails() /** * Sets error_details + * * @param \DocuSign\eSign\Model\ErrorDetails[] $error_details Array or errors. + * * @return $this */ public function setErrorDetails($error_details) @@ -245,7 +319,9 @@ public function setErrorDetails($error_details) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkRecipientsUpdateResponse.php b/src/Model/BulkRecipientsUpdateResponse.php index 409da93a..d6e75deb 100644 --- a/src/Model/BulkRecipientsUpdateResponse.php +++ b/src/Model/BulkRecipientsUpdateResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkRecipientsUpdateResponse Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkRecipientsUpdateResponse implements ArrayAccess +class BulkRecipientsUpdateResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkRecipientsUpdateResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'signer' => '\DocuSign\eSign\Model\Signer' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'signer' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'signer' => 'signer' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'signer' => 'setSigner' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'signer' => 'getSigner' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets signer + * * @return \DocuSign\eSign\Model\Signer */ public function getSigner() @@ -156,7 +216,9 @@ public function getSigner() /** * Sets signer - * @param \DocuSign\eSign\Model\Signer $signer + * + * @param \DocuSign\eSign\Model\Signer $signer signer + * * @return $this */ public function setSigner($signer) @@ -167,7 +229,9 @@ public function setSigner($signer) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendRequest.php b/src/Model/BulkSendRequest.php index eb6722bf..88150f54 100644 --- a/src/Model/BulkSendRequest.php +++ b/src/Model/BulkSendRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendRequest Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendRequest implements ArrayAccess +class BulkSendRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'envelope_or_template_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_or_template_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'envelope_or_template_id' => 'envelopeOrTemplateId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'envelope_or_template_id' => 'setEnvelopeOrTemplateId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'envelope_or_template_id' => 'getEnvelopeOrTemplateId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_or_template_id + * * @return string */ public function getEnvelopeOrTemplateId() @@ -156,7 +216,9 @@ public function getEnvelopeOrTemplateId() /** * Sets envelope_or_template_id + * * @param string $envelope_or_template_id + * * @return $this */ public function setEnvelopeOrTemplateId($envelope_or_template_id) @@ -167,7 +229,9 @@ public function setEnvelopeOrTemplateId($envelope_or_template_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendResponse.php b/src/Model/BulkSendResponse.php index 218fb850..3c9dbda5 100644 --- a/src/Model/BulkSendResponse.php +++ b/src/Model/BulkSendResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendResponse implements ArrayAccess +class BulkSendResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class BulkSendResponse implements ArrayAccess 'errors' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'batch_id' => null, + 'envelope_or_template_id' => null, + 'error_details' => null, + 'errors' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'errors' => 'errors' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'errors' => 'setErrors' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'errors' => 'getErrors' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets batch_id + * * @return string */ public function getBatchId() @@ -171,7 +234,9 @@ public function getBatchId() /** * Sets batch_id + * * @param string $batch_id + * * @return $this */ public function setBatchId($batch_id) @@ -183,6 +248,7 @@ public function setBatchId($batch_id) /** * Gets envelope_or_template_id + * * @return string */ public function getEnvelopeOrTemplateId() @@ -192,7 +258,9 @@ public function getEnvelopeOrTemplateId() /** * Sets envelope_or_template_id + * * @param string $envelope_or_template_id + * * @return $this */ public function setEnvelopeOrTemplateId($envelope_or_template_id) @@ -204,6 +272,7 @@ public function setEnvelopeOrTemplateId($envelope_or_template_id) /** * Gets error_details + * * @return string[] */ public function getErrorDetails() @@ -213,7 +282,9 @@ public function getErrorDetails() /** * Sets error_details + * * @param string[] $error_details Array or errors. + * * @return $this */ public function setErrorDetails($error_details) @@ -225,6 +296,7 @@ public function setErrorDetails($error_details) /** * Gets errors + * * @return string[] */ public function getErrors() @@ -234,7 +306,9 @@ public function getErrors() /** * Sets errors + * * @param string[] $errors + * * @return $this */ public function setErrors($errors) @@ -245,7 +319,9 @@ public function setErrors($errors) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendTestResponse.php b/src/Model/BulkSendTestResponse.php index 8a22f421..5a09ec11 100644 --- a/src/Model/BulkSendTestResponse.php +++ b/src/Model/BulkSendTestResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendTestResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendTestResponse implements ArrayAccess +class BulkSendTestResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendTestResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class BulkSendTestResponse implements ArrayAccess 'validation_errors' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'can_be_sent' => null, + 'validation_error_details' => null, + 'validation_errors' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'validation_errors' => 'validationErrors' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'validation_errors' => 'setValidationErrors' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'validation_errors' => 'getValidationErrors' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets can_be_sent + * * @return bool */ public function getCanBeSent() @@ -166,7 +228,9 @@ public function getCanBeSent() /** * Sets can_be_sent + * * @param bool $can_be_sent + * * @return $this */ public function setCanBeSent($can_be_sent) @@ -178,6 +242,7 @@ public function setCanBeSent($can_be_sent) /** * Gets validation_error_details + * * @return string[] */ public function getValidationErrorDetails() @@ -187,7 +252,9 @@ public function getValidationErrorDetails() /** * Sets validation_error_details + * * @param string[] $validation_error_details + * * @return $this */ public function setValidationErrorDetails($validation_error_details) @@ -199,6 +266,7 @@ public function setValidationErrorDetails($validation_error_details) /** * Gets validation_errors + * * @return string[] */ public function getValidationErrors() @@ -208,7 +276,9 @@ public function getValidationErrors() /** * Sets validation_errors + * * @param string[] $validation_errors + * * @return $this */ public function setValidationErrors($validation_errors) @@ -219,7 +289,9 @@ public function setValidationErrors($validation_errors) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendingCopy.php b/src/Model/BulkSendingCopy.php index 73e2f240..44518aa0 100644 --- a/src/Model/BulkSendingCopy.php +++ b/src/Model/BulkSendingCopy.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendingCopy Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendingCopy implements ArrayAccess +class BulkSendingCopy implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendingCopy'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class BulkSendingCopy implements ArrayAccess 'recipients' => '\DocuSign\eSign\Model\BulkSendingCopyRecipient[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'custom_fields' => null, + 'email_blurb' => null, + 'email_subject' => null, + 'recipients' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'recipients' => 'recipients' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'recipients' => 'setRecipients' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'recipients' => 'getRecipients' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\BulkSendingCopyCustomField[] */ public function getCustomFields() @@ -171,7 +234,9 @@ public function getCustomFields() /** * Sets custom_fields + * * @param \DocuSign\eSign\Model\BulkSendingCopyCustomField[] $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) @@ -183,6 +248,7 @@ public function setCustomFields($custom_fields) /** * Gets email_blurb + * * @return string */ public function getEmailBlurb() @@ -192,7 +258,9 @@ public function getEmailBlurb() /** * Sets email_blurb + * * @param string $email_blurb + * * @return $this */ public function setEmailBlurb($email_blurb) @@ -204,6 +272,7 @@ public function setEmailBlurb($email_blurb) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -213,7 +282,9 @@ public function getEmailSubject() /** * Sets email_subject + * * @param string $email_subject Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. + * * @return $this */ public function setEmailSubject($email_subject) @@ -225,6 +296,7 @@ public function setEmailSubject($email_subject) /** * Gets recipients + * * @return \DocuSign\eSign\Model\BulkSendingCopyRecipient[] */ public function getRecipients() @@ -234,7 +306,9 @@ public function getRecipients() /** * Sets recipients + * * @param \DocuSign\eSign\Model\BulkSendingCopyRecipient[] $recipients An array of powerform recipients. + * * @return $this */ public function setRecipients($recipients) @@ -245,7 +319,9 @@ public function setRecipients($recipients) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendingCopyCustomField.php b/src/Model/BulkSendingCopyCustomField.php index 0de41e20..cebddaa5 100644 --- a/src/Model/BulkSendingCopyCustomField.php +++ b/src/Model/BulkSendingCopyCustomField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendingCopyCustomField Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendingCopyCustomField implements ArrayAccess +class BulkSendingCopyCustomField implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendingCopyCustomField'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class BulkSendingCopyCustomField implements ArrayAccess 'value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'name' => null, + 'value' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'value' => 'value' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'value' => 'setValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'value' => 'getValue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets name + * * @return string */ public function getName() @@ -161,7 +222,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -173,6 +236,7 @@ public function setName($name) /** * Gets value + * * @return string */ public function getValue() @@ -182,7 +246,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -193,7 +259,9 @@ public function setValue($value) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendingCopyRecipient.php b/src/Model/BulkSendingCopyRecipient.php index d45a1e31..c77db0ad 100644 --- a/src/Model/BulkSendingCopyRecipient.php +++ b/src/Model/BulkSendingCopyRecipient.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendingCopyRecipient Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendingCopyRecipient implements ArrayAccess +class BulkSendingCopyRecipient implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendingCopyRecipient'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -76,13 +79,58 @@ class BulkSendingCopyRecipient implements ArrayAccess 'tabs' => '\DocuSign\eSign\Model\BulkSendingCopyTab[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'client_user_id' => null, + 'custom_fields' => null, + 'delivery_method' => null, + 'email' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'fax_number' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identification_method' => null, + 'name' => null, + 'note' => null, + 'phone_authentication' => null, + 'recipient_id' => null, + 'recipient_signature_providers' => null, + 'role_name' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'tabs' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -108,9 +156,9 @@ public static function swaggerTypes() 'tabs' => 'tabs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -136,9 +184,9 @@ public static function swaggerTypes() 'tabs' => 'setTabs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -164,34 +212,63 @@ public static function swaggerTypes() 'tabs' => 'getTabs' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -218,30 +295,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -251,7 +330,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -263,6 +344,7 @@ public function setAccessCode($access_code) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -272,7 +354,9 @@ public function getClientUserId() /** * 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) @@ -284,6 +368,7 @@ public function setClientUserId($client_user_id) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -293,7 +378,9 @@ public function getCustomFields() /** * 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) @@ -305,6 +392,7 @@ public function setCustomFields($custom_fields) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -314,7 +402,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -326,6 +416,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets email + * * @return string */ public function getEmail() @@ -335,7 +426,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -347,6 +440,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -356,7 +450,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -368,6 +464,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -377,7 +474,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -389,6 +488,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -398,7 +498,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -410,6 +512,7 @@ public function setFaxNumber($fax_number) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -419,7 +522,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -431,6 +536,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -440,7 +546,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -452,6 +560,7 @@ public function setIdCheckInformationInput($id_check_information_input) /** * Gets identification_method + * * @return string */ public function getIdentificationMethod() @@ -461,7 +570,9 @@ public function getIdentificationMethod() /** * Sets identification_method + * * @param string $identification_method + * * @return $this */ public function setIdentificationMethod($identification_method) @@ -473,6 +584,7 @@ public function setIdentificationMethod($identification_method) /** * Gets name + * * @return string */ public function getName() @@ -482,7 +594,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -494,6 +608,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -503,7 +618,9 @@ public function getNote() /** * 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) @@ -515,6 +632,7 @@ public function setNote($note) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -524,7 +642,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -536,6 +656,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -545,7 +666,9 @@ public function getRecipientId() /** * 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) @@ -557,6 +680,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -566,7 +690,9 @@ public function getRecipientSignatureProviders() /** * Sets recipient_signature_providers + * * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * * @return $this */ public function setRecipientSignatureProviders($recipient_signature_providers) @@ -578,6 +704,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -587,7 +714,9 @@ public function getRoleName() /** * 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) @@ -599,6 +728,7 @@ public function setRoleName($role_name) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -608,7 +738,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -620,6 +752,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -629,7 +762,9 @@ public function getSocialAuthentications() /** * 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) @@ -641,6 +776,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets tabs + * * @return \DocuSign\eSign\Model\BulkSendingCopyTab[] */ public function getTabs() @@ -650,7 +786,9 @@ public function getTabs() /** * Sets tabs + * * @param \DocuSign\eSign\Model\BulkSendingCopyTab[] $tabs + * * @return $this */ public function setTabs($tabs) @@ -661,7 +799,9 @@ public function setTabs($tabs) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -671,7 +811,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -681,8 +823,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -696,7 +840,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -706,16 +852,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendingCopyTab.php b/src/Model/BulkSendingCopyTab.php index d4362d2b..8a2365dd 100644 --- a/src/Model/BulkSendingCopyTab.php +++ b/src/Model/BulkSendingCopyTab.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendingCopyTab Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendingCopyTab implements ArrayAccess +class BulkSendingCopyTab implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendingCopyTab'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class BulkSendingCopyTab implements ArrayAccess 'tab_label' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'initial_value' => null, + 'tab_label' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'tab_label' => 'tabLabel' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'tab_label' => 'setTabLabel' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'tab_label' => 'getTabLabel' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets initial_value + * * @return string */ public function getInitialValue() @@ -161,7 +222,9 @@ public function getInitialValue() /** * Sets initial_value + * * @param string $initial_value The original value of the tab. + * * @return $this */ public function setInitialValue($initial_value) @@ -173,6 +236,7 @@ public function setInitialValue($initial_value) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -182,7 +246,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -193,7 +259,9 @@ public function setTabLabel($tab_label) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendingList.php b/src/Model/BulkSendingList.php index 2f9f855d..f393e1d1 100644 --- a/src/Model/BulkSendingList.php +++ b/src/Model/BulkSendingList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendingList Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendingList implements ArrayAccess +class BulkSendingList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendingList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class BulkSendingList implements ArrayAccess 'name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_copies' => null, + 'list_id' => null, + 'name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'name' => 'name' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'name' => 'setName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'name' => 'getName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_copies + * * @return \DocuSign\eSign\Model\BulkSendingCopy[] */ public function getBulkCopies() @@ -166,7 +228,9 @@ public function getBulkCopies() /** * Sets bulk_copies + * * @param \DocuSign\eSign\Model\BulkSendingCopy[] $bulk_copies + * * @return $this */ public function setBulkCopies($bulk_copies) @@ -178,6 +242,7 @@ public function setBulkCopies($bulk_copies) /** * Gets list_id + * * @return string */ public function getListId() @@ -187,7 +252,9 @@ public function getListId() /** * Sets list_id + * * @param string $list_id + * * @return $this */ public function setListId($list_id) @@ -199,6 +266,7 @@ public function setListId($list_id) /** * Gets name + * * @return string */ public function getName() @@ -208,7 +276,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -219,7 +289,9 @@ public function setName($name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendingListSummaries.php b/src/Model/BulkSendingListSummaries.php index 8750494b..c57f480f 100644 --- a/src/Model/BulkSendingListSummaries.php +++ b/src/Model/BulkSendingListSummaries.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendingListSummaries Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendingListSummaries implements ArrayAccess +class BulkSendingListSummaries implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendingListSummaries'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'bulk_list_summaries' => '\DocuSign\eSign\Model\BulkSendingListSummary[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_list_summaries' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'bulk_list_summaries' => 'bulkListSummaries' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'bulk_list_summaries' => 'setBulkListSummaries' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'bulk_list_summaries' => 'getBulkListSummaries' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_list_summaries + * * @return \DocuSign\eSign\Model\BulkSendingListSummary[] */ public function getBulkListSummaries() @@ -156,7 +216,9 @@ public function getBulkListSummaries() /** * Sets bulk_list_summaries + * * @param \DocuSign\eSign\Model\BulkSendingListSummary[] $bulk_list_summaries + * * @return $this */ public function setBulkListSummaries($bulk_list_summaries) @@ -167,7 +229,9 @@ public function setBulkListSummaries($bulk_list_summaries) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/BulkSendingListSummary.php b/src/Model/BulkSendingListSummary.php index 1bf46917..e24e0719 100644 --- a/src/Model/BulkSendingListSummary.php +++ b/src/Model/BulkSendingListSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * BulkSendingListSummary Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class BulkSendingListSummary implements ArrayAccess +class BulkSendingListSummary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'bulkSendingListSummary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class BulkSendingListSummary implements ArrayAccess 'name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_send_list_id' => null, + 'created_by_user' => null, + 'created_date' => null, + 'name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'name' => 'name' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'name' => 'setName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'name' => 'getName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_send_list_id + * * @return string */ public function getBulkSendListId() @@ -171,7 +234,9 @@ public function getBulkSendListId() /** * Sets bulk_send_list_id + * * @param string $bulk_send_list_id + * * @return $this */ public function setBulkSendListId($bulk_send_list_id) @@ -183,6 +248,7 @@ public function setBulkSendListId($bulk_send_list_id) /** * Gets created_by_user + * * @return string */ public function getCreatedByUser() @@ -192,7 +258,9 @@ public function getCreatedByUser() /** * Sets created_by_user + * * @param string $created_by_user + * * @return $this */ public function setCreatedByUser($created_by_user) @@ -204,6 +272,7 @@ public function setCreatedByUser($created_by_user) /** * Gets created_date + * * @return string */ public function getCreatedDate() @@ -213,7 +282,9 @@ public function getCreatedDate() /** * Sets created_date + * * @param string $created_date + * * @return $this */ public function setCreatedDate($created_date) @@ -225,6 +296,7 @@ public function setCreatedDate($created_date) /** * Gets name + * * @return string */ public function getName() @@ -234,7 +306,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -245,7 +319,9 @@ public function setName($name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CaptiveRecipient.php b/src/Model/CaptiveRecipient.php index e841be6f..36f4ebba 100644 --- a/src/Model/CaptiveRecipient.php +++ b/src/Model/CaptiveRecipient.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CaptiveRecipient Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CaptiveRecipient implements ArrayAccess +class CaptiveRecipient implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'captiveRecipient'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class CaptiveRecipient implements ArrayAccess 'user_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'client_user_id' => null, + 'email' => null, + 'error_details' => null, + 'user_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'user_name' => 'userName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'user_name' => 'setUserName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'user_name' => 'getUserName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -171,7 +234,9 @@ public function getClientUserId() /** * 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) @@ -183,6 +248,7 @@ public function setClientUserId($client_user_id) /** * Gets email + * * @return string */ public function getEmail() @@ -192,7 +258,9 @@ public function getEmail() /** * Sets email + * * @param string $email Specifies the email address associated with the captive recipient. + * * @return $this */ public function setEmail($email) @@ -204,6 +272,7 @@ public function setEmail($email) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -213,7 +282,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -225,6 +296,7 @@ public function setErrorDetails($error_details) /** * Gets user_name + * * @return string */ public function getUserName() @@ -234,7 +306,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name Specifies the user name associated with the captive recipient. + * * @return $this */ public function setUserName($user_name) @@ -245,7 +319,9 @@ public function setUserName($user_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CaptiveRecipientInformation.php b/src/Model/CaptiveRecipientInformation.php index 5e651c20..ecc9709e 100644 --- a/src/Model/CaptiveRecipientInformation.php +++ b/src/Model/CaptiveRecipientInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CaptiveRecipientInformation Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CaptiveRecipientInformation implements ArrayAccess +class CaptiveRecipientInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'captiveRecipientInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'captive_recipients' => '\DocuSign\eSign\Model\CaptiveRecipient[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'captive_recipients' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'captive_recipients' => 'captiveRecipients' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'captive_recipients' => 'setCaptiveRecipients' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'captive_recipients' => 'getCaptiveRecipients' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets captive_recipients + * * @return \DocuSign\eSign\Model\CaptiveRecipient[] */ public function getCaptiveRecipients() @@ -156,7 +216,9 @@ public function getCaptiveRecipients() /** * Sets captive_recipients + * * @param \DocuSign\eSign\Model\CaptiveRecipient[] $captive_recipients A complex type containing information about one or more captive recipients. + * * @return $this */ public function setCaptiveRecipients($captive_recipients) @@ -167,7 +229,9 @@ public function setCaptiveRecipients($captive_recipients) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CarbonCopy.php b/src/Model/CarbonCopy.php index b9132939..48a7f6ce 100644 --- a/src/Model/CarbonCopy.php +++ b/src/Model/CarbonCopy.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CarbonCopy Class Doc Comment @@ -39,24 +40,28 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CarbonCopy implements ArrayAccess +class CarbonCopy implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'carbonCopy'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'access_code' => 'string', 'access_code_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'add_access_code_to_email' => 'string', + 'additional_notifications' => '\DocuSign\eSign\Model\RecipientAdditionalNotification[]', + 'additional_notifications_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'agent_can_edit_email' => 'string', 'agent_can_edit_name' => 'string', 'allow_system_override_for_locked_recipient' => 'string', @@ -128,19 +133,120 @@ class CarbonCopy implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'additional_notifications' => null, + 'additional_notifications_metadata' => null, + 'agent_can_edit_email' => null, + 'agent_can_edit_name' => null, + 'allow_system_override_for_locked_recipient' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email' => null, + 'email_metadata' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'first_name' => null, + 'first_name_metadata' => null, + 'full_name' => null, + 'full_name_metadata' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'last_name_metadata' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'name_metadata' => null, + 'note' => null, + 'note_metadata' => null, + 'phone_authentication' => null, + 'proof_file' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_id_metadata' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'tabs' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'access_code' => 'accessCode', 'access_code_metadata' => 'accessCodeMetadata', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'additional_notifications' => 'additionalNotifications', + 'additional_notifications_metadata' => 'additionalNotificationsMetadata', 'agent_can_edit_email' => 'agentCanEditEmail', 'agent_can_edit_name' => 'agentCanEditName', 'allow_system_override_for_locked_recipient' => 'allowSystemOverrideForLockedRecipient', @@ -212,15 +318,17 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'access_code' => 'setAccessCode', 'access_code_metadata' => 'setAccessCodeMetadata', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'additional_notifications' => 'setAdditionalNotifications', + 'additional_notifications_metadata' => 'setAdditionalNotificationsMetadata', 'agent_can_edit_email' => 'setAgentCanEditEmail', 'agent_can_edit_name' => 'setAgentCanEditName', 'allow_system_override_for_locked_recipient' => 'setAllowSystemOverrideForLockedRecipient', @@ -292,15 +400,17 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'access_code' => 'getAccessCode', 'access_code_metadata' => 'getAccessCodeMetadata', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'additional_notifications' => 'getAdditionalNotifications', + 'additional_notifications_metadata' => 'getAdditionalNotificationsMetadata', 'agent_can_edit_email' => 'getAgentCanEditEmail', 'agent_can_edit_name' => 'getAgentCanEditName', 'allow_system_override_for_locked_recipient' => 'getAllowSystemOverrideForLockedRecipient', @@ -372,40 +482,71 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @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['access_code_metadata'] = isset($data['access_code_metadata']) ? $data['access_code_metadata'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['additional_notifications'] = isset($data['additional_notifications']) ? $data['additional_notifications'] : null; + $this->container['additional_notifications_metadata'] = isset($data['additional_notifications_metadata']) ? $data['additional_notifications_metadata'] : 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['allow_system_override_for_locked_recipient'] = isset($data['allow_system_override_for_locked_recipient']) ? $data['allow_system_override_for_locked_recipient'] : null; @@ -478,30 +619,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -511,7 +654,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -523,6 +668,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -532,7 +678,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -544,6 +692,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -553,7 +702,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -563,8 +714,57 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets additional_notifications + * + * @return \DocuSign\eSign\Model\RecipientAdditionalNotification[] + */ + public function getAdditionalNotifications() + { + return $this->container['additional_notifications']; + } + + /** + * Sets additional_notifications + * + * @param \DocuSign\eSign\Model\RecipientAdditionalNotification[] $additional_notifications + * + * @return $this + */ + public function setAdditionalNotifications($additional_notifications) + { + $this->container['additional_notifications'] = $additional_notifications; + + return $this; + } + + /** + * Gets additional_notifications_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getAdditionalNotificationsMetadata() + { + return $this->container['additional_notifications_metadata']; + } + + /** + * Sets additional_notifications_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $additional_notifications_metadata additional_notifications_metadata + * + * @return $this + */ + public function setAdditionalNotificationsMetadata($additional_notifications_metadata) + { + $this->container['additional_notifications_metadata'] = $additional_notifications_metadata; + + return $this; + } + /** * Gets agent_can_edit_email + * * @return string */ public function getAgentCanEditEmail() @@ -574,7 +774,9 @@ public function getAgentCanEditEmail() /** * Sets agent_can_edit_email + * * @param string $agent_can_edit_email + * * @return $this */ public function setAgentCanEditEmail($agent_can_edit_email) @@ -586,6 +788,7 @@ public function setAgentCanEditEmail($agent_can_edit_email) /** * Gets agent_can_edit_name + * * @return string */ public function getAgentCanEditName() @@ -595,7 +798,9 @@ public function getAgentCanEditName() /** * Sets agent_can_edit_name + * * @param string $agent_can_edit_name + * * @return $this */ public function setAgentCanEditName($agent_can_edit_name) @@ -607,6 +812,7 @@ public function setAgentCanEditName($agent_can_edit_name) /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -616,7 +822,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -628,6 +836,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -637,7 +846,9 @@ public function getClientUserId() /** * 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) @@ -649,6 +860,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -658,7 +870,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -670,6 +884,7 @@ public function setCompletedCount($completed_count) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -679,7 +894,9 @@ public function getCustomFields() /** * 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) @@ -691,6 +908,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -700,7 +918,9 @@ public function getDeclinedDateTime() /** * 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) @@ -712,6 +932,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -721,7 +942,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -733,6 +956,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -742,7 +966,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -754,6 +980,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -763,7 +990,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -775,6 +1004,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -784,7 +1014,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -796,6 +1028,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -805,7 +1038,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -817,6 +1052,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -826,7 +1062,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -838,6 +1076,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -847,7 +1086,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -859,6 +1100,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -868,7 +1110,9 @@ public function getEmail() /** * Sets email + * * @param string $email Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. + * * @return $this */ public function setEmail($email) @@ -880,6 +1124,7 @@ public function setEmail($email) /** * Gets email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailMetadata() @@ -889,7 +1134,9 @@ public function getEmailMetadata() /** * Sets email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata email_metadata + * * @return $this */ public function setEmailMetadata($email_metadata) @@ -901,6 +1148,7 @@ public function setEmailMetadata($email_metadata) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -910,7 +1158,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -922,6 +1172,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -931,7 +1182,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -943,6 +1196,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -952,7 +1206,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -964,6 +1220,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -973,7 +1230,9 @@ public function getExcludedDocuments() /** * 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) @@ -985,6 +1244,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -994,7 +1254,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -1006,6 +1268,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -1015,7 +1278,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -1027,6 +1292,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -1036,7 +1302,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -1048,6 +1316,7 @@ public function setFirstName($first_name) /** * Gets first_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFirstNameMetadata() @@ -1057,7 +1326,9 @@ public function getFirstNameMetadata() /** * Sets first_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata first_name_metadata + * * @return $this */ public function setFirstNameMetadata($first_name_metadata) @@ -1069,6 +1340,7 @@ public function setFirstNameMetadata($first_name_metadata) /** * Gets full_name + * * @return string */ public function getFullName() @@ -1078,7 +1350,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -1090,6 +1364,7 @@ public function setFullName($full_name) /** * Gets full_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFullNameMetadata() @@ -1099,7 +1374,9 @@ public function getFullNameMetadata() /** * Sets full_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata full_name_metadata + * * @return $this */ public function setFullNameMetadata($full_name_metadata) @@ -1111,6 +1388,7 @@ public function setFullNameMetadata($full_name_metadata) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -1120,7 +1398,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -1132,6 +1412,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -1141,7 +1422,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -1153,6 +1436,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1162,7 +1446,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -1174,6 +1460,7 @@ public function setIdCheckInformationInput($id_check_information_input) /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\RecipientIdentityVerification */ public function getIdentityVerification() @@ -1183,7 +1470,9 @@ public function getIdentityVerification() /** * Sets identity_verification - * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * * @return $this */ public function setIdentityVerification($identity_verification) @@ -1195,6 +1484,7 @@ public function setIdentityVerification($identity_verification) /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1204,7 +1494,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -1216,6 +1508,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -1225,7 +1518,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -1237,6 +1532,7 @@ public function setLastName($last_name) /** * Gets last_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLastNameMetadata() @@ -1246,7 +1542,9 @@ public function getLastNameMetadata() /** * Sets last_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata last_name_metadata + * * @return $this */ public function setLastNameMetadata($last_name_metadata) @@ -1258,6 +1556,7 @@ public function setLastNameMetadata($last_name_metadata) /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -1267,7 +1566,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -1279,6 +1580,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -1288,7 +1590,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -1300,6 +1604,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -1309,7 +1614,9 @@ public function getName() /** * Sets name + * * @param string $name legal name of the recipient. Maximum Length: 100 characters. + * * @return $this */ public function setName($name) @@ -1321,6 +1628,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1330,7 +1638,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1342,6 +1652,7 @@ public function setNameMetadata($name_metadata) /** * Gets note + * * @return string */ public function getNote() @@ -1351,7 +1662,9 @@ public function getNote() /** * 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) @@ -1363,6 +1676,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1372,7 +1686,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1384,6 +1700,7 @@ public function setNoteMetadata($note_metadata) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1393,7 +1710,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1405,6 +1724,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets proof_file + * * @return \DocuSign\eSign\Model\RecipientProofFile */ public function getProofFile() @@ -1414,7 +1734,9 @@ public function getProofFile() /** * Sets proof_file - * @param \DocuSign\eSign\Model\RecipientProofFile $proof_file + * + * @param \DocuSign\eSign\Model\RecipientProofFile $proof_file proof_file + * * @return $this */ public function setProofFile($proof_file) @@ -1426,6 +1748,7 @@ public function setProofFile($proof_file) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1435,7 +1758,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1447,6 +1772,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1456,7 +1782,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1468,6 +1796,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1477,7 +1806,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1489,6 +1820,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1498,7 +1830,9 @@ public function getRecipientId() /** * 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) @@ -1510,6 +1844,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1519,7 +1854,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1531,6 +1868,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1540,7 +1878,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1552,6 +1892,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1561,7 +1902,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1573,6 +1916,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1582,7 +1926,9 @@ public function getRequireIdLookup() /** * 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) @@ -1594,6 +1940,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1603,7 +1950,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1615,6 +1964,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1624,7 +1974,9 @@ public function getRoleName() /** * 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) @@ -1636,6 +1988,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1645,7 +1998,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -1657,6 +2012,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -1666,7 +2022,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -1678,6 +2036,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1687,7 +2046,9 @@ public function getSentDateTime() /** * 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) @@ -1699,6 +2060,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1708,7 +2070,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -1720,6 +2084,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1729,7 +2094,9 @@ public function getSigningGroupId() /** * 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) @@ -1741,6 +2108,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSigningGroupIdMetadata() @@ -1750,7 +2118,9 @@ public function getSigningGroupIdMetadata() /** * Sets signing_group_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata signing_group_id_metadata + * * @return $this */ public function setSigningGroupIdMetadata($signing_group_id_metadata) @@ -1762,6 +2132,7 @@ public function setSigningGroupIdMetadata($signing_group_id_metadata) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1771,7 +2142,9 @@ public function getSigningGroupName() /** * 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) @@ -1783,6 +2156,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1792,7 +2166,9 @@ public function getSigningGroupUsers() /** * 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) @@ -1804,6 +2180,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1813,7 +2190,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -1825,6 +2204,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1834,7 +2214,9 @@ public function getSocialAuthentications() /** * 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) @@ -1846,6 +2228,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1855,7 +2238,9 @@ public function getStatus() /** * 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) @@ -1867,6 +2252,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -1876,7 +2262,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -1888,6 +2276,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -1897,7 +2286,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -1909,6 +2300,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -1918,7 +2310,9 @@ public function getTabs() /** * Sets tabs - * @param \DocuSign\eSign\Model\Tabs $tabs + * + * @param \DocuSign\eSign\Model\Tabs $tabs tabs + * * @return $this */ public function setTabs($tabs) @@ -1930,6 +2324,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1939,7 +2334,9 @@ public function getTemplateLocked() /** * 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) @@ -1951,6 +2348,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1960,7 +2358,9 @@ public function getTemplateRequired() /** * 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) @@ -1972,6 +2372,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1981,7 +2382,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1993,6 +2396,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -2002,7 +2406,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -2013,7 +2419,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2023,7 +2431,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2033,8 +2443,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2048,7 +2460,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2058,16 +2472,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CertifiedDelivery.php b/src/Model/CertifiedDelivery.php index 23627e4d..44f9bccd 100644 --- a/src/Model/CertifiedDelivery.php +++ b/src/Model/CertifiedDelivery.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CertifiedDelivery Class Doc Comment @@ -39,24 +40,28 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CertifiedDelivery implements ArrayAccess +class CertifiedDelivery implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'certifiedDelivery'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'access_code' => 'string', 'access_code_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'add_access_code_to_email' => 'string', + 'additional_notifications' => '\DocuSign\eSign\Model\RecipientAdditionalNotification[]', + 'additional_notifications_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'agent_can_edit_email' => 'string', 'agent_can_edit_name' => 'string', 'allow_system_override_for_locked_recipient' => 'string', @@ -127,19 +132,119 @@ class CertifiedDelivery implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'additional_notifications' => null, + 'additional_notifications_metadata' => null, + 'agent_can_edit_email' => null, + 'agent_can_edit_name' => null, + 'allow_system_override_for_locked_recipient' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email' => null, + 'email_metadata' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'first_name' => null, + 'first_name_metadata' => null, + 'full_name' => null, + 'full_name_metadata' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'last_name_metadata' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'name_metadata' => null, + 'note' => null, + 'note_metadata' => null, + 'phone_authentication' => null, + 'proof_file' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_id_metadata' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'access_code' => 'accessCode', 'access_code_metadata' => 'accessCodeMetadata', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'additional_notifications' => 'additionalNotifications', + 'additional_notifications_metadata' => 'additionalNotificationsMetadata', 'agent_can_edit_email' => 'agentCanEditEmail', 'agent_can_edit_name' => 'agentCanEditName', 'allow_system_override_for_locked_recipient' => 'allowSystemOverrideForLockedRecipient', @@ -210,15 +315,17 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'access_code' => 'setAccessCode', 'access_code_metadata' => 'setAccessCodeMetadata', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'additional_notifications' => 'setAdditionalNotifications', + 'additional_notifications_metadata' => 'setAdditionalNotificationsMetadata', 'agent_can_edit_email' => 'setAgentCanEditEmail', 'agent_can_edit_name' => 'setAgentCanEditName', 'allow_system_override_for_locked_recipient' => 'setAllowSystemOverrideForLockedRecipient', @@ -289,15 +396,17 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'access_code' => 'getAccessCode', 'access_code_metadata' => 'getAccessCodeMetadata', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'additional_notifications' => 'getAdditionalNotifications', + 'additional_notifications_metadata' => 'getAdditionalNotificationsMetadata', 'agent_can_edit_email' => 'getAgentCanEditEmail', 'agent_can_edit_name' => 'getAgentCanEditName', 'allow_system_override_for_locked_recipient' => 'getAllowSystemOverrideForLockedRecipient', @@ -368,40 +477,71 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @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['access_code_metadata'] = isset($data['access_code_metadata']) ? $data['access_code_metadata'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['additional_notifications'] = isset($data['additional_notifications']) ? $data['additional_notifications'] : null; + $this->container['additional_notifications_metadata'] = isset($data['additional_notifications_metadata']) ? $data['additional_notifications_metadata'] : 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['allow_system_override_for_locked_recipient'] = isset($data['allow_system_override_for_locked_recipient']) ? $data['allow_system_override_for_locked_recipient'] : null; @@ -473,30 +613,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -506,7 +648,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -518,6 +662,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -527,7 +672,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -539,6 +686,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -548,7 +696,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -558,8 +708,57 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets additional_notifications + * + * @return \DocuSign\eSign\Model\RecipientAdditionalNotification[] + */ + public function getAdditionalNotifications() + { + return $this->container['additional_notifications']; + } + + /** + * Sets additional_notifications + * + * @param \DocuSign\eSign\Model\RecipientAdditionalNotification[] $additional_notifications + * + * @return $this + */ + public function setAdditionalNotifications($additional_notifications) + { + $this->container['additional_notifications'] = $additional_notifications; + + return $this; + } + + /** + * Gets additional_notifications_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getAdditionalNotificationsMetadata() + { + return $this->container['additional_notifications_metadata']; + } + + /** + * Sets additional_notifications_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $additional_notifications_metadata additional_notifications_metadata + * + * @return $this + */ + public function setAdditionalNotificationsMetadata($additional_notifications_metadata) + { + $this->container['additional_notifications_metadata'] = $additional_notifications_metadata; + + return $this; + } + /** * Gets agent_can_edit_email + * * @return string */ public function getAgentCanEditEmail() @@ -569,7 +768,9 @@ public function getAgentCanEditEmail() /** * Sets agent_can_edit_email + * * @param string $agent_can_edit_email + * * @return $this */ public function setAgentCanEditEmail($agent_can_edit_email) @@ -581,6 +782,7 @@ public function setAgentCanEditEmail($agent_can_edit_email) /** * Gets agent_can_edit_name + * * @return string */ public function getAgentCanEditName() @@ -590,7 +792,9 @@ public function getAgentCanEditName() /** * Sets agent_can_edit_name + * * @param string $agent_can_edit_name + * * @return $this */ public function setAgentCanEditName($agent_can_edit_name) @@ -602,6 +806,7 @@ public function setAgentCanEditName($agent_can_edit_name) /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -611,7 +816,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -623,6 +830,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -632,7 +840,9 @@ public function getClientUserId() /** * 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) @@ -644,6 +854,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -653,7 +864,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -665,6 +878,7 @@ public function setCompletedCount($completed_count) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -674,7 +888,9 @@ public function getCustomFields() /** * 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) @@ -686,6 +902,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -695,7 +912,9 @@ public function getDeclinedDateTime() /** * 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) @@ -707,6 +926,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -716,7 +936,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -728,6 +950,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -737,7 +960,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -749,6 +974,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -758,7 +984,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -770,6 +998,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -779,7 +1008,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -791,6 +1022,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -800,7 +1032,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -812,6 +1046,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -821,7 +1056,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -833,6 +1070,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -842,7 +1080,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -854,6 +1094,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -863,7 +1104,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -875,6 +1118,7 @@ public function setEmail($email) /** * Gets email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailMetadata() @@ -884,7 +1128,9 @@ public function getEmailMetadata() /** * Sets email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata email_metadata + * * @return $this */ public function setEmailMetadata($email_metadata) @@ -896,6 +1142,7 @@ public function setEmailMetadata($email_metadata) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -905,7 +1152,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -917,6 +1166,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -926,7 +1176,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -938,6 +1190,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -947,7 +1200,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -959,6 +1214,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -968,7 +1224,9 @@ public function getExcludedDocuments() /** * 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) @@ -980,6 +1238,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -989,7 +1248,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -1001,6 +1262,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -1010,7 +1272,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -1022,6 +1286,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -1031,7 +1296,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -1043,6 +1310,7 @@ public function setFirstName($first_name) /** * Gets first_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFirstNameMetadata() @@ -1052,7 +1320,9 @@ public function getFirstNameMetadata() /** * Sets first_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata first_name_metadata + * * @return $this */ public function setFirstNameMetadata($first_name_metadata) @@ -1064,6 +1334,7 @@ public function setFirstNameMetadata($first_name_metadata) /** * Gets full_name + * * @return string */ public function getFullName() @@ -1073,7 +1344,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -1085,6 +1358,7 @@ public function setFullName($full_name) /** * Gets full_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFullNameMetadata() @@ -1094,7 +1368,9 @@ public function getFullNameMetadata() /** * Sets full_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata full_name_metadata + * * @return $this */ public function setFullNameMetadata($full_name_metadata) @@ -1106,6 +1382,7 @@ public function setFullNameMetadata($full_name_metadata) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -1115,7 +1392,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -1127,6 +1406,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -1136,7 +1416,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -1148,6 +1430,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1157,7 +1440,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -1169,6 +1454,7 @@ public function setIdCheckInformationInput($id_check_information_input) /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\RecipientIdentityVerification */ public function getIdentityVerification() @@ -1178,7 +1464,9 @@ public function getIdentityVerification() /** * Sets identity_verification - * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * * @return $this */ public function setIdentityVerification($identity_verification) @@ -1190,6 +1478,7 @@ public function setIdentityVerification($identity_verification) /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1199,7 +1488,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -1211,6 +1502,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -1220,7 +1512,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -1232,6 +1526,7 @@ public function setLastName($last_name) /** * Gets last_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLastNameMetadata() @@ -1241,7 +1536,9 @@ public function getLastNameMetadata() /** * Sets last_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata last_name_metadata + * * @return $this */ public function setLastNameMetadata($last_name_metadata) @@ -1253,6 +1550,7 @@ public function setLastNameMetadata($last_name_metadata) /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -1262,7 +1560,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -1274,6 +1574,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -1283,7 +1584,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -1295,6 +1598,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -1304,7 +1608,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1316,6 +1622,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1325,7 +1632,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1337,6 +1646,7 @@ public function setNameMetadata($name_metadata) /** * Gets note + * * @return string */ public function getNote() @@ -1346,7 +1656,9 @@ public function getNote() /** * 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) @@ -1358,6 +1670,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1367,7 +1680,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1379,6 +1694,7 @@ public function setNoteMetadata($note_metadata) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1388,7 +1704,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1400,6 +1718,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets proof_file + * * @return \DocuSign\eSign\Model\RecipientProofFile */ public function getProofFile() @@ -1409,7 +1728,9 @@ public function getProofFile() /** * Sets proof_file - * @param \DocuSign\eSign\Model\RecipientProofFile $proof_file + * + * @param \DocuSign\eSign\Model\RecipientProofFile $proof_file proof_file + * * @return $this */ public function setProofFile($proof_file) @@ -1421,6 +1742,7 @@ public function setProofFile($proof_file) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1430,7 +1752,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1442,6 +1766,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1451,7 +1776,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1463,6 +1790,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1472,7 +1800,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1484,6 +1814,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1493,7 +1824,9 @@ public function getRecipientId() /** * 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) @@ -1505,6 +1838,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1514,7 +1848,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1526,6 +1862,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1535,7 +1872,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1547,6 +1886,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1556,7 +1896,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1568,6 +1910,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1577,7 +1920,9 @@ public function getRequireIdLookup() /** * 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) @@ -1589,6 +1934,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1598,7 +1944,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1610,6 +1958,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1619,7 +1968,9 @@ public function getRoleName() /** * 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) @@ -1631,6 +1982,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1640,7 +1992,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -1652,6 +2006,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -1661,7 +2016,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -1673,6 +2030,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1682,7 +2040,9 @@ public function getSentDateTime() /** * 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) @@ -1694,6 +2054,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1703,7 +2064,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -1715,6 +2078,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1724,7 +2088,9 @@ public function getSigningGroupId() /** * 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) @@ -1736,6 +2102,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSigningGroupIdMetadata() @@ -1745,7 +2112,9 @@ public function getSigningGroupIdMetadata() /** * Sets signing_group_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata signing_group_id_metadata + * * @return $this */ public function setSigningGroupIdMetadata($signing_group_id_metadata) @@ -1757,6 +2126,7 @@ public function setSigningGroupIdMetadata($signing_group_id_metadata) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1766,7 +2136,9 @@ public function getSigningGroupName() /** * 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) @@ -1778,6 +2150,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1787,7 +2160,9 @@ public function getSigningGroupUsers() /** * 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) @@ -1799,6 +2174,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1808,7 +2184,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -1820,6 +2198,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1829,7 +2208,9 @@ public function getSocialAuthentications() /** * 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) @@ -1841,6 +2222,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1850,7 +2232,9 @@ public function getStatus() /** * 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) @@ -1862,6 +2246,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -1871,7 +2256,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -1883,6 +2270,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -1892,7 +2280,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -1904,6 +2294,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1913,7 +2304,9 @@ public function getTemplateLocked() /** * 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) @@ -1925,6 +2318,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1934,7 +2328,9 @@ public function getTemplateRequired() /** * 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) @@ -1946,6 +2342,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1955,7 +2352,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1967,6 +2366,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1976,7 +2376,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1987,7 +2389,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1997,7 +2401,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2007,8 +2413,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2022,7 +2430,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2032,16 +2442,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Checkbox.php b/src/Model/Checkbox.php index b7578d62..c5572869 100644 --- a/src/Model/Checkbox.php +++ b/src/Model/Checkbox.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Checkbox Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Checkbox implements ArrayAccess +class Checkbox implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'checkbox'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -150,13 +153,132 @@ class Checkbox implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locked' => null, + 'locked_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'selected' => null, + 'selected_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -256,9 +378,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -358,9 +480,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -460,34 +582,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -588,30 +739,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -621,7 +774,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -633,6 +788,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -642,7 +798,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -654,6 +812,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -663,7 +822,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -675,6 +836,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -684,7 +846,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -696,6 +860,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -705,7 +870,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -717,6 +884,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -726,7 +894,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -738,6 +908,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -747,7 +918,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -759,6 +932,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -768,7 +942,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -780,6 +956,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -789,7 +966,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -801,6 +980,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -810,7 +990,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -822,6 +1004,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -831,7 +1014,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -843,6 +1028,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -852,7 +1038,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -864,6 +1052,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -873,7 +1062,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -885,6 +1076,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -894,7 +1086,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -906,6 +1100,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -915,7 +1110,9 @@ public function getAnchorUnits() /** * 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) @@ -927,6 +1124,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -936,7 +1134,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -948,6 +1148,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -957,7 +1158,9 @@ public function getAnchorXOffset() /** * 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) @@ -969,6 +1172,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -978,7 +1182,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -990,6 +1196,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -999,7 +1206,9 @@ public function getAnchorYOffset() /** * 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) @@ -1011,6 +1220,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1020,7 +1230,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1032,6 +1244,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1041,7 +1254,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1053,6 +1268,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1062,7 +1278,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1074,6 +1292,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1083,7 +1302,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1095,6 +1316,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1104,7 +1326,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1116,6 +1340,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1125,7 +1350,9 @@ public function getConditionalParentValue() /** * 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) @@ -1137,6 +1364,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1146,7 +1374,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1158,6 +1388,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1167,7 +1398,9 @@ public function getCustomTabId() /** * 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) @@ -1179,6 +1412,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1188,7 +1422,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1200,6 +1436,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1209,7 +1446,9 @@ public function getDocumentId() /** * 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) @@ -1221,6 +1460,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1230,7 +1470,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1242,6 +1484,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1251,7 +1494,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1263,6 +1508,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1272,7 +1518,9 @@ public function getFont() /** * 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) @@ -1284,6 +1532,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1293,7 +1542,9 @@ public function getFontColor() /** * 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) @@ -1305,6 +1556,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1314,7 +1566,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1326,6 +1580,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1335,7 +1590,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1347,6 +1604,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1356,7 +1614,9 @@ public function getFontSize() /** * 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) @@ -1368,6 +1628,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1377,7 +1638,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1389,6 +1652,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1398,7 +1662,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1410,6 +1676,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1419,7 +1686,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1431,6 +1700,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1440,7 +1710,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1452,6 +1724,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1461,7 +1734,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1473,6 +1748,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1482,7 +1758,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1494,6 +1772,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1503,7 +1782,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1515,6 +1796,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1524,7 +1806,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1536,6 +1820,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1545,7 +1830,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1557,6 +1844,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1566,7 +1854,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1578,6 +1868,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1587,7 +1878,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1599,6 +1892,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locked + * * @return string */ public function getLocked() @@ -1608,7 +1902,9 @@ public function getLocked() /** * 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) @@ -1620,6 +1916,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1629,7 +1926,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1641,6 +1940,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1650,7 +1950,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1662,6 +1964,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1671,7 +1974,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1683,6 +1988,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1692,7 +1998,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -1704,6 +2012,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1713,7 +2022,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1725,6 +2036,7 @@ public function setNameMetadata($name_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1734,7 +2046,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1746,6 +2060,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1755,7 +2070,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1767,6 +2084,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1776,7 +2094,9 @@ public function getRecipientId() /** * 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) @@ -1788,6 +2108,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1797,7 +2118,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1809,6 +2132,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1818,7 +2142,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1830,6 +2156,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1839,7 +2166,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1851,6 +2180,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -1860,7 +2190,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -1872,6 +2204,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -1881,7 +2214,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -1893,6 +2228,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -1902,7 +2238,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -1914,6 +2252,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -1923,7 +2262,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -1935,6 +2276,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets selected + * * @return string */ public function getSelected() @@ -1944,7 +2286,9 @@ public function getSelected() /** * Sets selected + * * @param string $selected When set to **true**, the checkbox is selected. + * * @return $this */ public function setSelected($selected) @@ -1956,6 +2300,7 @@ public function setSelected($selected) /** * Gets selected_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSelectedMetadata() @@ -1965,7 +2310,9 @@ public function getSelectedMetadata() /** * Sets selected_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $selected_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $selected_metadata selected_metadata + * * @return $this */ public function setSelectedMetadata($selected_metadata) @@ -1977,6 +2324,7 @@ public function setSelectedMetadata($selected_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -1986,7 +2334,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1998,6 +2348,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -2007,7 +2358,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -2019,6 +2372,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2028,7 +2382,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2040,6 +2396,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2049,7 +2406,9 @@ public function getStatus() /** * 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) @@ -2061,6 +2420,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2070,7 +2430,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2082,6 +2444,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2091,7 +2454,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2103,6 +2468,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2112,7 +2478,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2124,6 +2492,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2133,7 +2502,9 @@ public function getTabId() /** * 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) @@ -2145,6 +2516,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2154,7 +2526,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2166,6 +2540,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2175,7 +2550,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2187,6 +2564,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2196,7 +2574,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2208,6 +2588,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2217,7 +2598,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2229,6 +2612,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2238,7 +2622,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2250,6 +2636,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2259,7 +2646,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2271,6 +2660,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2280,7 +2670,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2292,6 +2684,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2301,7 +2694,9 @@ public function getTemplateLocked() /** * 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) @@ -2313,6 +2708,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2322,7 +2718,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2334,6 +2732,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2343,7 +2742,9 @@ public function getTemplateRequired() /** * 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) @@ -2355,6 +2756,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2364,7 +2766,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2376,6 +2780,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2385,7 +2790,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2397,6 +2804,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2406,7 +2814,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2418,6 +2828,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2427,7 +2838,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2439,6 +2852,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2448,7 +2862,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2460,6 +2876,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2469,7 +2886,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2481,6 +2900,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2490,7 +2910,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2502,6 +2924,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2511,7 +2934,9 @@ public function getXPosition() /** * 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) @@ -2523,6 +2948,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2532,7 +2958,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2544,6 +2972,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2553,7 +2982,9 @@ public function getYPosition() /** * 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) @@ -2565,6 +2996,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2574,7 +3006,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2585,7 +3019,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2595,7 +3031,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2605,8 +3043,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2620,7 +3060,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2630,16 +3072,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ChunkedUploadPart.php b/src/Model/ChunkedUploadPart.php index 430fe59b..216f2803 100644 --- a/src/Model/ChunkedUploadPart.php +++ b/src/Model/ChunkedUploadPart.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ChunkedUploadPart Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ChunkedUploadPart implements ArrayAccess +class ChunkedUploadPart implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'chunkedUploadPart'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class ChunkedUploadPart implements ArrayAccess 'size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'sequence' => null, + 'size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'size' => 'size' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'size' => 'setSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'size' => 'getSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets sequence + * * @return string */ public function getSequence() @@ -161,7 +222,9 @@ public function getSequence() /** * Sets sequence + * * @param string $sequence + * * @return $this */ public function setSequence($sequence) @@ -173,6 +236,7 @@ public function setSequence($sequence) /** * Gets size + * * @return string */ public function getSize() @@ -182,7 +246,9 @@ public function getSize() /** * Sets size + * * @param string $size + * * @return $this */ public function setSize($size) @@ -193,7 +259,9 @@ public function setSize($size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ChunkedUploadRequest.php b/src/Model/ChunkedUploadRequest.php index a075bede..05305732 100644 --- a/src/Model/ChunkedUploadRequest.php +++ b/src/Model/ChunkedUploadRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ChunkedUploadRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ChunkedUploadRequest implements ArrayAccess +class ChunkedUploadRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'chunkedUploadRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class ChunkedUploadRequest implements ArrayAccess 'data' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'chunked_upload_id' => null, + 'data' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'data' => 'data' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'data' => 'setData' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'data' => 'getData' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets chunked_upload_id + * * @return string */ public function getChunkedUploadId() @@ -161,7 +222,9 @@ public function getChunkedUploadId() /** * Sets chunked_upload_id + * * @param string $chunked_upload_id + * * @return $this */ public function setChunkedUploadId($chunked_upload_id) @@ -173,6 +236,7 @@ public function setChunkedUploadId($chunked_upload_id) /** * Gets data + * * @return string */ public function getData() @@ -182,7 +246,9 @@ public function getData() /** * Sets data + * * @param string $data + * * @return $this */ public function setData($data) @@ -193,7 +259,9 @@ public function setData($data) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ChunkedUploadResponse.php b/src/Model/ChunkedUploadResponse.php index 8a124b87..31c0c2e9 100644 --- a/src/Model/ChunkedUploadResponse.php +++ b/src/Model/ChunkedUploadResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ChunkedUploadResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ChunkedUploadResponse implements ArrayAccess +class ChunkedUploadResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'chunkedUploadResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,47 @@ class ChunkedUploadResponse implements ArrayAccess 'total_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'checksum' => null, + 'chunked_upload_id' => null, + 'chunked_upload_parts' => null, + 'chunked_upload_uri' => null, + 'committed' => null, + 'expiration_date_time' => null, + 'max_chunked_upload_parts' => null, + 'max_total_size' => null, + 'total_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -86,9 +123,9 @@ public static function swaggerTypes() 'total_size' => 'totalSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -103,9 +140,9 @@ public static function swaggerTypes() 'total_size' => 'setTotalSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -120,34 +157,63 @@ public static function swaggerTypes() 'total_size' => 'getTotalSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -163,30 +229,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets checksum + * * @return string */ public function getChecksum() @@ -196,7 +264,9 @@ public function getChecksum() /** * Sets checksum + * * @param string $checksum + * * @return $this */ public function setChecksum($checksum) @@ -208,6 +278,7 @@ public function setChecksum($checksum) /** * Gets chunked_upload_id + * * @return string */ public function getChunkedUploadId() @@ -217,7 +288,9 @@ public function getChunkedUploadId() /** * Sets chunked_upload_id + * * @param string $chunked_upload_id + * * @return $this */ public function setChunkedUploadId($chunked_upload_id) @@ -229,6 +302,7 @@ public function setChunkedUploadId($chunked_upload_id) /** * Gets chunked_upload_parts + * * @return \DocuSign\eSign\Model\ChunkedUploadPart[] */ public function getChunkedUploadParts() @@ -238,7 +312,9 @@ public function getChunkedUploadParts() /** * Sets chunked_upload_parts + * * @param \DocuSign\eSign\Model\ChunkedUploadPart[] $chunked_upload_parts + * * @return $this */ public function setChunkedUploadParts($chunked_upload_parts) @@ -250,6 +326,7 @@ public function setChunkedUploadParts($chunked_upload_parts) /** * Gets chunked_upload_uri + * * @return string */ public function getChunkedUploadUri() @@ -259,7 +336,9 @@ public function getChunkedUploadUri() /** * Sets chunked_upload_uri + * * @param string $chunked_upload_uri + * * @return $this */ public function setChunkedUploadUri($chunked_upload_uri) @@ -271,6 +350,7 @@ public function setChunkedUploadUri($chunked_upload_uri) /** * Gets committed + * * @return string */ public function getCommitted() @@ -280,7 +360,9 @@ public function getCommitted() /** * Sets committed + * * @param string $committed + * * @return $this */ public function setCommitted($committed) @@ -292,6 +374,7 @@ public function setCommitted($committed) /** * Gets expiration_date_time + * * @return string */ public function getExpirationDateTime() @@ -301,7 +384,9 @@ public function getExpirationDateTime() /** * Sets expiration_date_time + * * @param string $expiration_date_time + * * @return $this */ public function setExpirationDateTime($expiration_date_time) @@ -313,6 +398,7 @@ public function setExpirationDateTime($expiration_date_time) /** * Gets max_chunked_upload_parts + * * @return string */ public function getMaxChunkedUploadParts() @@ -322,7 +408,9 @@ public function getMaxChunkedUploadParts() /** * Sets max_chunked_upload_parts + * * @param string $max_chunked_upload_parts + * * @return $this */ public function setMaxChunkedUploadParts($max_chunked_upload_parts) @@ -334,6 +422,7 @@ public function setMaxChunkedUploadParts($max_chunked_upload_parts) /** * Gets max_total_size + * * @return string */ public function getMaxTotalSize() @@ -343,7 +432,9 @@ public function getMaxTotalSize() /** * Sets max_total_size + * * @param string $max_total_size + * * @return $this */ public function setMaxTotalSize($max_total_size) @@ -355,6 +446,7 @@ public function setMaxTotalSize($max_total_size) /** * Gets total_size + * * @return string */ public function getTotalSize() @@ -364,7 +456,9 @@ public function getTotalSize() /** * Sets total_size + * * @param string $total_size + * * @return $this */ public function setTotalSize($total_size) @@ -375,7 +469,9 @@ public function setTotalSize($total_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -385,7 +481,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -395,8 +493,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -410,7 +510,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -420,16 +522,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CloudStorageProvider.php b/src/Model/CloudStorageProvider.php index d0b1d209..31e1b1fd 100644 --- a/src/Model/CloudStorageProvider.php +++ b/src/Model/CloudStorageProvider.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CloudStorageProvider Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CloudStorageProvider implements ArrayAccess +class CloudStorageProvider implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'cloudStorageProvider'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class CloudStorageProvider implements ArrayAccess 'service_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'authentication_url' => null, + 'error_details' => null, + 'redirect_url' => null, + 'service' => null, + 'service_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'service_id' => 'serviceId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'service_id' => 'setServiceId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'service_id' => 'getServiceId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets authentication_url + * * @return string */ public function getAuthenticationUrl() @@ -176,7 +240,9 @@ public function getAuthenticationUrl() /** * Sets authentication_url + * * @param string $authentication_url The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. + * * @return $this */ public function setAuthenticationUrl($authentication_url) @@ -188,6 +254,7 @@ public function setAuthenticationUrl($authentication_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -197,7 +264,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -209,6 +278,7 @@ public function setErrorDetails($error_details) /** * Gets redirect_url + * * @return string */ public function getRedirectUrl() @@ -218,7 +288,9 @@ public function getRedirectUrl() /** * Sets redirect_url + * * @param string $redirect_url The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains. + * * @return $this */ public function setRedirectUrl($redirect_url) @@ -230,6 +302,7 @@ public function setRedirectUrl($redirect_url) /** * Gets service + * * @return string */ public function getService() @@ -239,7 +312,9 @@ public function getService() /** * Sets service + * * @param string $service The service name for the cloud storage provider. + * * @return $this */ public function setService($service) @@ -251,6 +326,7 @@ public function setService($service) /** * Gets service_id + * * @return string */ public function getServiceId() @@ -260,7 +336,9 @@ public function getServiceId() /** * Sets service_id + * * @param string $service_id The DocuSign generated ID for the cloud storage provider + * * @return $this */ public function setServiceId($service_id) @@ -271,7 +349,9 @@ public function setServiceId($service_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CloudStorageProviders.php b/src/Model/CloudStorageProviders.php index 38a328ed..01f1c115 100644 --- a/src/Model/CloudStorageProviders.php +++ b/src/Model/CloudStorageProviders.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CloudStorageProviders Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CloudStorageProviders implements ArrayAccess +class CloudStorageProviders implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'cloudStorageProviders'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'storage_providers' => '\DocuSign\eSign\Model\CloudStorageProvider[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'storage_providers' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'storage_providers' => 'storageProviders' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'storage_providers' => 'setStorageProviders' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'storage_providers' => 'getStorageProviders' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets storage_providers + * * @return \DocuSign\eSign\Model\CloudStorageProvider[] */ public function getStorageProviders() @@ -156,7 +216,9 @@ public function getStorageProviders() /** * Sets storage_providers + * * @param \DocuSign\eSign\Model\CloudStorageProvider[] $storage_providers An Array containing the storage providers associated with the user. + * * @return $this */ public function setStorageProviders($storage_providers) @@ -167,7 +229,9 @@ public function setStorageProviders($storage_providers) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Comment.php b/src/Model/Comment.php index bc544d82..839c663c 100644 --- a/src/Model/Comment.php +++ b/src/Model/Comment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Comment Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Comment implements ArrayAccess +class Comment implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'comment'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -77,13 +80,59 @@ class Comment implements ArrayAccess 'visible_to' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_id' => null, + 'hmac' => null, + 'id' => null, + 'mentions' => null, + 'read' => null, + 'sent_by_email' => null, + 'sent_by_full_name' => null, + 'sent_by_image_id' => null, + 'sent_by_initials' => null, + 'sent_by_recipient_id' => null, + 'sent_by_user_id' => null, + 'signing_group_id' => null, + 'signing_group_name' => null, + 'subject' => null, + 'tab_id' => null, + 'text' => null, + 'thread_id' => null, + 'thread_originator_id' => null, + 'timestamp' => null, + 'time_stamp_formatted' => null, + 'visible_to' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -110,9 +159,9 @@ public static function swaggerTypes() 'visible_to' => 'visibleTo' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -139,9 +188,9 @@ public static function swaggerTypes() 'visible_to' => 'setVisibleTo' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -168,34 +217,63 @@ public static function swaggerTypes() 'visible_to' => 'getVisibleTo' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -223,30 +301,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -256,7 +336,9 @@ public function getEnvelopeId() /** * 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) @@ -268,6 +350,7 @@ public function setEnvelopeId($envelope_id) /** * Gets hmac + * * @return string */ public function getHmac() @@ -277,7 +360,9 @@ public function getHmac() /** * Sets hmac + * * @param string $hmac + * * @return $this */ public function setHmac($hmac) @@ -289,6 +374,7 @@ public function setHmac($hmac) /** * Gets id + * * @return string */ public function getId() @@ -298,7 +384,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -310,6 +398,7 @@ public function setId($id) /** * Gets mentions + * * @return string[] */ public function getMentions() @@ -319,7 +408,9 @@ public function getMentions() /** * Sets mentions + * * @param string[] $mentions + * * @return $this */ public function setMentions($mentions) @@ -331,6 +422,7 @@ public function setMentions($mentions) /** * Gets read + * * @return bool */ public function getRead() @@ -340,7 +432,9 @@ public function getRead() /** * Sets read + * * @param bool $read + * * @return $this */ public function setRead($read) @@ -352,6 +446,7 @@ public function setRead($read) /** * Gets sent_by_email + * * @return string */ public function getSentByEmail() @@ -361,7 +456,9 @@ public function getSentByEmail() /** * Sets sent_by_email + * * @param string $sent_by_email + * * @return $this */ public function setSentByEmail($sent_by_email) @@ -373,6 +470,7 @@ public function setSentByEmail($sent_by_email) /** * Gets sent_by_full_name + * * @return string */ public function getSentByFullName() @@ -382,7 +480,9 @@ public function getSentByFullName() /** * Sets sent_by_full_name + * * @param string $sent_by_full_name + * * @return $this */ public function setSentByFullName($sent_by_full_name) @@ -394,6 +494,7 @@ public function setSentByFullName($sent_by_full_name) /** * Gets sent_by_image_id + * * @return string */ public function getSentByImageId() @@ -403,7 +504,9 @@ public function getSentByImageId() /** * Sets sent_by_image_id + * * @param string $sent_by_image_id + * * @return $this */ public function setSentByImageId($sent_by_image_id) @@ -415,6 +518,7 @@ public function setSentByImageId($sent_by_image_id) /** * Gets sent_by_initials + * * @return string */ public function getSentByInitials() @@ -424,7 +528,9 @@ public function getSentByInitials() /** * Sets sent_by_initials + * * @param string $sent_by_initials + * * @return $this */ public function setSentByInitials($sent_by_initials) @@ -436,6 +542,7 @@ public function setSentByInitials($sent_by_initials) /** * Gets sent_by_recipient_id + * * @return string */ public function getSentByRecipientId() @@ -445,7 +552,9 @@ public function getSentByRecipientId() /** * Sets sent_by_recipient_id + * * @param string $sent_by_recipient_id + * * @return $this */ public function setSentByRecipientId($sent_by_recipient_id) @@ -457,6 +566,7 @@ public function setSentByRecipientId($sent_by_recipient_id) /** * Gets sent_by_user_id + * * @return string */ public function getSentByUserId() @@ -466,7 +576,9 @@ public function getSentByUserId() /** * Sets sent_by_user_id + * * @param string $sent_by_user_id + * * @return $this */ public function setSentByUserId($sent_by_user_id) @@ -478,6 +590,7 @@ public function setSentByUserId($sent_by_user_id) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -487,7 +600,9 @@ public function getSigningGroupId() /** * 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) @@ -499,6 +614,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -508,7 +624,9 @@ public function getSigningGroupName() /** * 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) @@ -520,6 +638,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets subject + * * @return string */ public function getSubject() @@ -529,7 +648,9 @@ public function getSubject() /** * Sets subject + * * @param string $subject + * * @return $this */ public function setSubject($subject) @@ -541,6 +662,7 @@ public function setSubject($subject) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -550,7 +672,9 @@ public function getTabId() /** * 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) @@ -562,6 +686,7 @@ public function setTabId($tab_id) /** * Gets text + * * @return string */ public function getText() @@ -571,7 +696,9 @@ public function getText() /** * Sets text + * * @param string $text + * * @return $this */ public function setText($text) @@ -583,6 +710,7 @@ public function setText($text) /** * Gets thread_id + * * @return string */ public function getThreadId() @@ -592,7 +720,9 @@ public function getThreadId() /** * Sets thread_id + * * @param string $thread_id + * * @return $this */ public function setThreadId($thread_id) @@ -604,6 +734,7 @@ public function setThreadId($thread_id) /** * Gets thread_originator_id + * * @return string */ public function getThreadOriginatorId() @@ -613,7 +744,9 @@ public function getThreadOriginatorId() /** * Sets thread_originator_id + * * @param string $thread_originator_id + * * @return $this */ public function setThreadOriginatorId($thread_originator_id) @@ -625,6 +758,7 @@ public function setThreadOriginatorId($thread_originator_id) /** * Gets timestamp + * * @return string */ public function getTimestamp() @@ -634,7 +768,9 @@ public function getTimestamp() /** * Sets timestamp + * * @param string $timestamp + * * @return $this */ public function setTimestamp($timestamp) @@ -646,6 +782,7 @@ public function setTimestamp($timestamp) /** * Gets time_stamp_formatted + * * @return string */ public function getTimeStampFormatted() @@ -655,7 +792,9 @@ public function getTimeStampFormatted() /** * Sets time_stamp_formatted + * * @param string $time_stamp_formatted + * * @return $this */ public function setTimeStampFormatted($time_stamp_formatted) @@ -667,6 +806,7 @@ public function setTimeStampFormatted($time_stamp_formatted) /** * Gets visible_to + * * @return string[] */ public function getVisibleTo() @@ -676,7 +816,9 @@ public function getVisibleTo() /** * Sets visible_to + * * @param string[] $visible_to + * * @return $this */ public function setVisibleTo($visible_to) @@ -687,7 +829,9 @@ public function setVisibleTo($visible_to) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -697,7 +841,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -707,8 +853,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -722,7 +870,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -732,16 +882,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CommentHistoryResult.php b/src/Model/CommentHistoryResult.php index f49f0f68..242c1cd2 100644 --- a/src/Model/CommentHistoryResult.php +++ b/src/Model/CommentHistoryResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CommentHistoryResult Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CommentHistoryResult implements ArrayAccess +class CommentHistoryResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'commentHistoryResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class CommentHistoryResult implements ArrayAccess 'start_timetoken' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'comments' => null, + 'count' => 'int32', + 'end_timetoken' => null, + 'start_timetoken' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'start_timetoken' => 'startTimetoken' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'start_timetoken' => 'setStartTimetoken' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'start_timetoken' => 'getStartTimetoken' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets comments + * * @return \DocuSign\eSign\Model\Comment[] */ public function getComments() @@ -171,7 +234,9 @@ public function getComments() /** * Sets comments + * * @param \DocuSign\eSign\Model\Comment[] $comments + * * @return $this */ public function setComments($comments) @@ -183,6 +248,7 @@ public function setComments($comments) /** * Gets count + * * @return int */ public function getCount() @@ -192,7 +258,9 @@ public function getCount() /** * Sets count + * * @param int $count + * * @return $this */ public function setCount($count) @@ -204,6 +272,7 @@ public function setCount($count) /** * Gets end_timetoken + * * @return string */ public function getEndTimetoken() @@ -213,7 +282,9 @@ public function getEndTimetoken() /** * Sets end_timetoken + * * @param string $end_timetoken + * * @return $this */ public function setEndTimetoken($end_timetoken) @@ -225,6 +296,7 @@ public function setEndTimetoken($end_timetoken) /** * Gets start_timetoken + * * @return string */ public function getStartTimetoken() @@ -234,7 +306,9 @@ public function getStartTimetoken() /** * Sets start_timetoken + * * @param string $start_timetoken + * * @return $this */ public function setStartTimetoken($start_timetoken) @@ -245,7 +319,9 @@ public function setStartTimetoken($start_timetoken) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CommentPublish.php b/src/Model/CommentPublish.php index addc815b..37a6bd98 100644 --- a/src/Model/CommentPublish.php +++ b/src/Model/CommentPublish.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CommentPublish Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CommentPublish implements ArrayAccess +class CommentPublish implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'commentPublish'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class CommentPublish implements ArrayAccess 'visible_to' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'id' => null, + 'mentions' => null, + 'text' => null, + 'thread_anchor_keys' => null, + 'thread_id' => null, + 'visible_to' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'visible_to' => 'visibleTo' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'visible_to' => 'setVisibleTo' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'visible_to' => 'getVisibleTo' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets id + * * @return string */ public function getId() @@ -181,7 +246,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -193,6 +260,7 @@ public function setId($id) /** * Gets mentions + * * @return string[] */ public function getMentions() @@ -202,7 +270,9 @@ public function getMentions() /** * Sets mentions + * * @param string[] $mentions + * * @return $this */ public function setMentions($mentions) @@ -214,6 +284,7 @@ public function setMentions($mentions) /** * Gets text + * * @return string */ public function getText() @@ -223,7 +294,9 @@ public function getText() /** * Sets text + * * @param string $text + * * @return $this */ public function setText($text) @@ -235,6 +308,7 @@ public function setText($text) /** * Gets thread_anchor_keys + * * @return map[string,string] */ public function getThreadAnchorKeys() @@ -244,7 +318,9 @@ public function getThreadAnchorKeys() /** * Sets thread_anchor_keys + * * @param map[string,string] $thread_anchor_keys + * * @return $this */ public function setThreadAnchorKeys($thread_anchor_keys) @@ -256,6 +332,7 @@ public function setThreadAnchorKeys($thread_anchor_keys) /** * Gets thread_id + * * @return string */ public function getThreadId() @@ -265,7 +342,9 @@ public function getThreadId() /** * Sets thread_id + * * @param string $thread_id + * * @return $this */ public function setThreadId($thread_id) @@ -277,6 +356,7 @@ public function setThreadId($thread_id) /** * Gets visible_to + * * @return string[] */ public function getVisibleTo() @@ -286,7 +366,9 @@ public function getVisibleTo() /** * Sets visible_to + * * @param string[] $visible_to + * * @return $this */ public function setVisibleTo($visible_to) @@ -297,7 +379,9 @@ public function setVisibleTo($visible_to) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CommentThread.php b/src/Model/CommentThread.php index 44aa93c6..b9df5b79 100644 --- a/src/Model/CommentThread.php +++ b/src/Model/CommentThread.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CommentThread Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CommentThread implements ArrayAccess +class CommentThread implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'commentThread'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -141,13 +144,123 @@ class CommentThread implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'comments' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'thread_id' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -238,9 +351,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -331,9 +444,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -424,34 +537,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -543,30 +685,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -576,7 +720,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -588,6 +734,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -597,7 +744,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -609,6 +758,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -618,7 +768,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -630,6 +782,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -639,7 +792,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -651,6 +806,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -660,7 +816,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -672,6 +830,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -681,7 +840,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -693,6 +854,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -702,7 +864,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -714,6 +878,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -723,7 +888,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -735,6 +902,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -744,7 +912,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -756,6 +926,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -765,7 +936,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -777,6 +950,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -786,7 +960,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -798,6 +974,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -807,7 +984,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -819,6 +998,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -828,7 +1008,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -840,6 +1022,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -849,7 +1032,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -861,6 +1046,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -870,7 +1056,9 @@ public function getAnchorUnits() /** * 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) @@ -882,6 +1070,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -891,7 +1080,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -903,6 +1094,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -912,7 +1104,9 @@ public function getAnchorXOffset() /** * 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) @@ -924,6 +1118,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -933,7 +1128,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -945,6 +1142,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -954,7 +1152,9 @@ public function getAnchorYOffset() /** * 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) @@ -966,6 +1166,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -975,7 +1176,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -987,6 +1190,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -996,7 +1200,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1008,6 +1214,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1017,7 +1224,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1029,6 +1238,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets comments + * * @return \DocuSign\eSign\Model\Comment[] */ public function getComments() @@ -1038,7 +1248,9 @@ public function getComments() /** * Sets comments + * * @param \DocuSign\eSign\Model\Comment[] $comments + * * @return $this */ public function setComments($comments) @@ -1050,6 +1262,7 @@ public function setComments($comments) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1059,7 +1272,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1071,6 +1286,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1080,7 +1296,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1092,6 +1310,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1101,7 +1320,9 @@ public function getConditionalParentValue() /** * 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) @@ -1113,6 +1334,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1122,7 +1344,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1134,6 +1358,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1143,7 +1368,9 @@ public function getCustomTabId() /** * 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) @@ -1155,6 +1382,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1164,7 +1392,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1176,6 +1406,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1185,7 +1416,9 @@ public function getDocumentId() /** * 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) @@ -1197,6 +1430,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1206,7 +1440,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1218,6 +1454,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1227,7 +1464,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1239,6 +1478,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1248,7 +1488,9 @@ public function getFont() /** * 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) @@ -1260,6 +1502,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1269,7 +1512,9 @@ public function getFontColor() /** * 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) @@ -1281,6 +1526,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1290,7 +1536,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1302,6 +1550,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1311,7 +1560,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1323,6 +1574,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1332,7 +1584,9 @@ public function getFontSize() /** * 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) @@ -1344,6 +1598,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1353,7 +1608,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1365,6 +1622,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1374,7 +1632,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1386,6 +1646,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1395,7 +1656,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1407,6 +1670,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1416,7 +1680,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1428,6 +1694,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1437,7 +1704,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1449,6 +1718,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1458,7 +1728,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1470,6 +1742,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1479,7 +1752,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1491,6 +1766,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1500,7 +1776,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1512,6 +1790,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1521,7 +1800,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1533,6 +1814,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1542,7 +1824,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1554,6 +1838,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1563,7 +1848,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1575,6 +1862,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1584,7 +1872,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1596,6 +1886,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1605,7 +1896,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1617,6 +1910,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1626,7 +1920,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1638,6 +1934,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1647,7 +1944,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1659,6 +1958,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1668,7 +1968,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1680,6 +1982,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1689,7 +1992,9 @@ public function getRecipientId() /** * 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) @@ -1701,6 +2006,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1710,7 +2016,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1722,6 +2030,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1731,7 +2040,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1743,6 +2054,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1752,7 +2064,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1764,6 +2078,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1773,7 +2088,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1785,6 +2102,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1794,7 +2112,9 @@ public function getStatus() /** * 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) @@ -1806,6 +2126,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1815,7 +2136,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1827,6 +2150,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1836,7 +2160,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1848,6 +2174,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1857,7 +2184,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1869,6 +2198,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1878,7 +2208,9 @@ public function getTabId() /** * 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) @@ -1890,6 +2222,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1899,7 +2232,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1911,6 +2246,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1920,7 +2256,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1932,6 +2270,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1941,7 +2280,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1953,6 +2294,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1962,7 +2304,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1974,6 +2318,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1983,7 +2328,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -1995,6 +2342,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2004,7 +2352,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2016,6 +2366,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2025,7 +2376,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2037,6 +2390,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2046,7 +2400,9 @@ public function getTemplateLocked() /** * 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) @@ -2058,6 +2414,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2067,7 +2424,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2079,6 +2438,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2088,7 +2448,9 @@ public function getTemplateRequired() /** * 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) @@ -2100,6 +2462,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2109,7 +2472,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2121,6 +2486,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets thread_id + * * @return string */ public function getThreadId() @@ -2130,7 +2496,9 @@ public function getThreadId() /** * Sets thread_id + * * @param string $thread_id + * * @return $this */ public function setThreadId($thread_id) @@ -2142,6 +2510,7 @@ public function setThreadId($thread_id) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2151,7 +2520,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2163,6 +2534,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2172,7 +2544,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2184,6 +2558,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2193,7 +2568,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2205,6 +2582,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2214,7 +2592,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2226,6 +2606,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2235,7 +2616,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2247,6 +2630,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2256,7 +2640,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2268,6 +2654,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2277,7 +2664,9 @@ public function getXPosition() /** * 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) @@ -2289,6 +2678,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2298,7 +2688,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2310,6 +2702,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2319,7 +2712,9 @@ public function getYPosition() /** * 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) @@ -2331,6 +2726,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2340,7 +2736,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2351,7 +2749,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2361,7 +2761,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2371,8 +2773,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2386,7 +2790,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2396,16 +2802,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CommentsPublish.php b/src/Model/CommentsPublish.php index edc4848e..3a6cec07 100644 --- a/src/Model/CommentsPublish.php +++ b/src/Model/CommentsPublish.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CommentsPublish Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CommentsPublish implements ArrayAccess +class CommentsPublish implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'commentsPublish'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'comments_to_publish' => '\DocuSign\eSign\Model\CommentPublish[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'comments_to_publish' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'comments_to_publish' => 'commentsToPublish' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'comments_to_publish' => 'setCommentsToPublish' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'comments_to_publish' => 'getCommentsToPublish' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets comments_to_publish + * * @return \DocuSign\eSign\Model\CommentPublish[] */ public function getCommentsToPublish() @@ -156,7 +216,9 @@ public function getCommentsToPublish() /** * Sets comments_to_publish + * * @param \DocuSign\eSign\Model\CommentPublish[] $comments_to_publish + * * @return $this */ public function setCommentsToPublish($comments_to_publish) @@ -167,7 +229,9 @@ public function setCommentsToPublish($comments_to_publish) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Company.php b/src/Model/Company.php index 841201f8..5396e7be 100644 --- a/src/Model/Company.php +++ b/src/Model/Company.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Company Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Company implements ArrayAccess +class Company implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'company'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -155,13 +158,137 @@ class Company implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conceal_value_on_document' => null, + 'conceal_value_on_document_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'disable_auto_size' => null, + 'disable_auto_size_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'max_length' => null, + 'max_length_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'original_value' => null, + 'original_value_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -266,9 +393,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -373,9 +500,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -480,34 +607,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -613,30 +769,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -646,7 +804,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -658,6 +818,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -667,7 +828,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -679,6 +842,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -688,7 +852,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -700,6 +866,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -709,7 +876,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -721,6 +890,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -730,7 +900,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -742,6 +914,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -751,7 +924,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -763,6 +938,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -772,7 +948,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -784,6 +962,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -793,7 +972,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -805,6 +986,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -814,7 +996,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -826,6 +1010,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -835,7 +1020,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -847,6 +1034,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -856,7 +1044,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -868,6 +1058,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -877,7 +1068,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -889,6 +1082,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -898,7 +1092,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -910,6 +1106,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -919,7 +1116,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -931,6 +1130,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -940,7 +1140,9 @@ public function getAnchorUnits() /** * 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) @@ -952,6 +1154,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -961,7 +1164,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -973,6 +1178,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -982,7 +1188,9 @@ public function getAnchorXOffset() /** * 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) @@ -994,6 +1202,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1003,7 +1212,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1015,6 +1226,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1024,7 +1236,9 @@ public function getAnchorYOffset() /** * 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) @@ -1036,6 +1250,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1045,7 +1260,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1057,6 +1274,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1066,7 +1284,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1078,6 +1298,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1087,7 +1308,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1099,6 +1322,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -1108,7 +1332,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -1120,6 +1346,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conceal_value_on_document_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConcealValueOnDocumentMetadata() @@ -1129,7 +1356,9 @@ public function getConcealValueOnDocumentMetadata() /** * Sets conceal_value_on_document_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata conceal_value_on_document_metadata + * * @return $this */ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_metadata) @@ -1141,6 +1370,7 @@ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_met /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1150,7 +1380,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1162,6 +1394,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1171,7 +1404,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1183,6 +1418,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1192,7 +1428,9 @@ public function getConditionalParentValue() /** * 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) @@ -1204,6 +1442,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1213,7 +1452,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1225,6 +1466,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1234,7 +1476,9 @@ public function getCustomTabId() /** * 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) @@ -1246,6 +1490,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1255,7 +1500,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1267,6 +1514,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -1276,7 +1524,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -1288,6 +1538,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets disable_auto_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisableAutoSizeMetadata() @@ -1297,7 +1548,9 @@ public function getDisableAutoSizeMetadata() /** * Sets disable_auto_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata disable_auto_size_metadata + * * @return $this */ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) @@ -1309,6 +1562,7 @@ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1318,7 +1572,9 @@ public function getDocumentId() /** * 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) @@ -1330,6 +1586,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1339,7 +1596,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1351,6 +1610,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1360,7 +1620,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1372,6 +1634,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1381,7 +1644,9 @@ public function getFont() /** * 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) @@ -1393,6 +1658,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1402,7 +1668,9 @@ public function getFontColor() /** * 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) @@ -1414,6 +1682,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1423,7 +1692,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1435,6 +1706,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1444,7 +1716,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1456,6 +1730,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1465,7 +1740,9 @@ public function getFontSize() /** * 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) @@ -1477,6 +1754,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1486,7 +1764,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1498,6 +1778,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1507,7 +1788,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1519,6 +1802,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1528,7 +1812,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1540,6 +1826,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1549,7 +1836,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1561,6 +1850,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1570,7 +1860,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1582,6 +1874,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1591,7 +1884,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1603,6 +1898,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1612,7 +1908,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1624,6 +1922,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1633,7 +1932,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1645,6 +1946,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1654,7 +1956,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1666,6 +1970,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1675,7 +1980,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1687,6 +1994,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1696,7 +2004,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1708,6 +2018,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1717,7 +2028,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1729,6 +2042,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1738,7 +2052,9 @@ public function getLocked() /** * 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) @@ -1750,6 +2066,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1759,7 +2076,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1771,6 +2090,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets max_length + * * @return string */ public function getMaxLength() @@ -1780,7 +2100,9 @@ public function getMaxLength() /** * Sets max_length + * * @param string $max_length An optional value that describes the maximum length of the property when the property is a string. + * * @return $this */ public function setMaxLength($max_length) @@ -1792,6 +2114,7 @@ public function setMaxLength($max_length) /** * Gets max_length_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaxLengthMetadata() @@ -1801,7 +2124,9 @@ public function getMaxLengthMetadata() /** * Sets max_length_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata max_length_metadata + * * @return $this */ public function setMaxLengthMetadata($max_length_metadata) @@ -1813,6 +2138,7 @@ public function setMaxLengthMetadata($max_length_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1822,7 +2148,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1834,6 +2162,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1843,7 +2172,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1855,6 +2186,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1864,7 +2196,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -1876,6 +2210,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1885,7 +2220,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1897,6 +2234,7 @@ public function setNameMetadata($name_metadata) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -1906,7 +2244,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -1918,6 +2258,7 @@ public function setOriginalValue($original_value) /** * Gets original_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOriginalValueMetadata() @@ -1927,7 +2268,9 @@ public function getOriginalValueMetadata() /** * Sets original_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata original_value_metadata + * * @return $this */ public function setOriginalValueMetadata($original_value_metadata) @@ -1939,6 +2282,7 @@ public function setOriginalValueMetadata($original_value_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1948,7 +2292,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1960,6 +2306,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1969,7 +2316,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1981,6 +2330,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1990,7 +2340,9 @@ public function getRecipientId() /** * 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) @@ -2002,6 +2354,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -2011,7 +2364,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -2023,6 +2378,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -2032,7 +2388,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -2044,6 +2402,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -2053,7 +2412,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -2065,6 +2426,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -2074,7 +2436,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -2086,6 +2450,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -2095,7 +2460,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2107,6 +2474,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2116,7 +2484,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2128,6 +2498,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2137,7 +2508,9 @@ public function getStatus() /** * 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) @@ -2149,6 +2522,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2158,7 +2532,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2170,6 +2546,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2179,7 +2556,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2191,6 +2570,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2200,7 +2580,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2212,6 +2594,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2221,7 +2604,9 @@ public function getTabId() /** * 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) @@ -2233,6 +2618,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2242,7 +2628,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2254,6 +2642,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2263,7 +2652,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2275,6 +2666,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2284,7 +2676,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2296,6 +2690,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2305,7 +2700,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2317,6 +2714,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2326,7 +2724,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2338,6 +2738,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2347,7 +2748,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2359,6 +2762,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2368,7 +2772,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2380,6 +2786,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2389,7 +2796,9 @@ public function getTemplateLocked() /** * 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) @@ -2401,6 +2810,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2410,7 +2820,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2422,6 +2834,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2431,7 +2844,9 @@ public function getTemplateRequired() /** * 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) @@ -2443,6 +2858,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2452,7 +2868,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2464,6 +2882,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2473,7 +2892,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2485,6 +2906,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2494,7 +2916,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2506,6 +2930,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2515,7 +2940,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2527,6 +2954,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2536,7 +2964,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2548,6 +2978,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2557,7 +2988,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2569,6 +3002,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2578,7 +3012,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2590,6 +3026,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2599,7 +3036,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2611,6 +3050,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2620,7 +3060,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2632,6 +3074,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2641,7 +3084,9 @@ public function getXPosition() /** * 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) @@ -2653,6 +3098,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2662,7 +3108,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2674,6 +3122,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2683,7 +3132,9 @@ public function getYPosition() /** * 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) @@ -2695,6 +3146,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2704,7 +3156,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2715,7 +3169,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2725,7 +3181,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2735,8 +3193,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2750,7 +3210,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2760,16 +3222,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CompositeTemplate.php b/src/Model/CompositeTemplate.php index 7348dcdd..c651d521 100644 --- a/src/Model/CompositeTemplate.php +++ b/src/Model/CompositeTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CompositeTemplate Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CompositeTemplate implements ArrayAccess +class CompositeTemplate implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'compositeTemplate'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class CompositeTemplate implements ArrayAccess 'server_templates' => '\DocuSign\eSign\Model\ServerTemplate[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'composite_template_id' => null, + 'document' => null, + 'inline_templates' => null, + 'pdf_meta_data_template_sequence' => null, + 'server_templates' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'server_templates' => 'serverTemplates' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'server_templates' => 'setServerTemplates' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'server_templates' => 'getServerTemplates' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets composite_template_id + * * @return string */ public function getCompositeTemplateId() @@ -176,7 +240,9 @@ 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. + * * @return $this */ public function setCompositeTemplateId($composite_template_id) @@ -188,6 +254,7 @@ public function setCompositeTemplateId($composite_template_id) /** * Gets document + * * @return \DocuSign\eSign\Model\Document */ public function getDocument() @@ -197,7 +264,9 @@ public function getDocument() /** * Sets document - * @param \DocuSign\eSign\Model\Document $document + * + * @param \DocuSign\eSign\Model\Document $document document + * * @return $this */ public function setDocument($document) @@ -209,6 +278,7 @@ public function setDocument($document) /** * Gets inline_templates + * * @return \DocuSign\eSign\Model\InlineTemplate[] */ public function getInlineTemplates() @@ -218,7 +288,9 @@ public function getInlineTemplates() /** * Sets inline_templates + * * @param \DocuSign\eSign\Model\InlineTemplate[] $inline_templates Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. + * * @return $this */ public function setInlineTemplates($inline_templates) @@ -230,6 +302,7 @@ public function setInlineTemplates($inline_templates) /** * Gets pdf_meta_data_template_sequence + * * @return string */ public function getPdfMetaDataTemplateSequence() @@ -239,7 +312,9 @@ public function getPdfMetaDataTemplateSequence() /** * Sets pdf_meta_data_template_sequence + * * @param string $pdf_meta_data_template_sequence + * * @return $this */ public function setPdfMetaDataTemplateSequence($pdf_meta_data_template_sequence) @@ -251,6 +326,7 @@ public function setPdfMetaDataTemplateSequence($pdf_meta_data_template_sequence) /** * Gets server_templates + * * @return \DocuSign\eSign\Model\ServerTemplate[] */ public function getServerTemplates() @@ -260,7 +336,9 @@ public function getServerTemplates() /** * Sets server_templates + * * @param \DocuSign\eSign\Model\ServerTemplate[] $server_templates 0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value + * * @return $this */ public function setServerTemplates($server_templates) @@ -271,7 +349,9 @@ public function setServerTemplates($server_templates) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectConfigResults.php b/src/Model/ConnectConfigResults.php index 001a2513..ca77d6b6 100644 --- a/src/Model/ConnectConfigResults.php +++ b/src/Model/ConnectConfigResults.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectConfigResults Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectConfigResults implements ArrayAccess +class ConnectConfigResults implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectConfigResults'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class ConnectConfigResults implements ArrayAccess 'total_records' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'configurations' => null, + 'total_records' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'total_records' => 'totalRecords' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'total_records' => 'setTotalRecords' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'total_records' => 'getTotalRecords' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets configurations + * * @return \DocuSign\eSign\Model\ConnectCustomConfiguration[] */ public function getConfigurations() @@ -161,7 +222,9 @@ public function getConfigurations() /** * Sets configurations + * * @param \DocuSign\eSign\Model\ConnectCustomConfiguration[] $configurations Reserved: TBD + * * @return $this */ public function setConfigurations($configurations) @@ -173,6 +236,7 @@ public function setConfigurations($configurations) /** * Gets total_records + * * @return string */ public function getTotalRecords() @@ -182,7 +246,9 @@ public function getTotalRecords() /** * Sets total_records + * * @param string $total_records + * * @return $this */ public function setTotalRecords($total_records) @@ -193,7 +259,9 @@ public function setTotalRecords($total_records) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectCustomConfiguration.php b/src/Model/ConnectCustomConfiguration.php index 3f071e0a..bf862b1d 100644 --- a/src/Model/ConnectCustomConfiguration.php +++ b/src/Model/ConnectCustomConfiguration.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectCustomConfiguration Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectCustomConfiguration implements ArrayAccess +class ConnectCustomConfiguration implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectCustomConfiguration'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -92,13 +95,74 @@ class ConnectCustomConfiguration implements ArrayAccess 'use_soap_interface' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_envelope_publish' => null, + 'allow_salesforce_publish' => null, + 'all_users' => null, + 'configuration_type' => null, + 'connect_id' => null, + 'enable_log' => null, + 'envelope_events' => null, + 'event_data' => null, + 'external_folder_id' => null, + 'external_folder_label' => null, + 'include_certificate_of_completion' => null, + 'include_cert_soap_header' => null, + 'include_document_fields' => null, + 'include_documents' => null, + 'include_envelope_void_reason' => null, + 'include_hmac' => null, + 'include_sender_accountas_custom_field' => null, + 'include_time_zone_information' => null, + 'name' => null, + 'password' => null, + 'recipient_events' => null, + 'require_mutual_tls' => null, + 'requires_acknowledgement' => null, + 'salesforce_api_version' => null, + 'salesforce_authcode' => null, + 'salesforce_call_back_url' => null, + 'salesforce_documents_as_content_files' => null, + 'sender_override' => null, + 'sender_selectable_items' => null, + 'sf_objects' => null, + 'sign_message_with_x509_certificate' => null, + 'soap_namespace' => null, + 'url_to_publish_to' => null, + 'user_ids' => null, + 'user_name' => null, + 'use_soap_interface' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -140,9 +204,9 @@ public static function swaggerTypes() 'use_soap_interface' => 'useSoapInterface' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -184,9 +248,9 @@ public static function swaggerTypes() 'use_soap_interface' => 'setUseSoapInterface' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -228,34 +292,63 @@ public static function swaggerTypes() 'use_soap_interface' => 'getUseSoapInterface' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -298,30 +391,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allow_envelope_publish + * * @return string */ public function getAllowEnvelopePublish() @@ -331,7 +426,9 @@ public function getAllowEnvelopePublish() /** * Sets allow_envelope_publish + * * @param string $allow_envelope_publish When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. + * * @return $this */ public function setAllowEnvelopePublish($allow_envelope_publish) @@ -343,6 +440,7 @@ public function setAllowEnvelopePublish($allow_envelope_publish) /** * Gets allow_salesforce_publish + * * @return string */ public function getAllowSalesforcePublish() @@ -352,7 +450,9 @@ public function getAllowSalesforcePublish() /** * Sets allow_salesforce_publish + * * @param string $allow_salesforce_publish + * * @return $this */ public function setAllowSalesforcePublish($allow_salesforce_publish) @@ -364,6 +464,7 @@ public function setAllowSalesforcePublish($allow_salesforce_publish) /** * Gets all_users + * * @return string */ public function getAllUsers() @@ -373,7 +474,9 @@ public function getAllUsers() /** * Sets all_users + * * @param string $all_users When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. + * * @return $this */ public function setAllUsers($all_users) @@ -385,6 +488,7 @@ public function setAllUsers($all_users) /** * Gets configuration_type + * * @return string */ public function getConfigurationType() @@ -394,7 +498,9 @@ public function getConfigurationType() /** * Sets configuration_type + * * @param string $configuration_type If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. + * * @return $this */ public function setConfigurationType($configuration_type) @@ -406,6 +512,7 @@ public function setConfigurationType($configuration_type) /** * Gets connect_id + * * @return string */ public function getConnectId() @@ -415,7 +522,9 @@ public function getConnectId() /** * Sets connect_id + * * @param string $connect_id Specifies the DocuSign generated ID for the Connect configuration. + * * @return $this */ public function setConnectId($connect_id) @@ -427,6 +536,7 @@ public function setConnectId($connect_id) /** * Gets enable_log + * * @return string */ public function getEnableLog() @@ -436,7 +546,9 @@ public function getEnableLog() /** * Sets enable_log + * * @param string $enable_log This turns Connect logging on or off. When set to **true**, logging is turned on. + * * @return $this */ public function setEnableLog($enable_log) @@ -448,6 +560,7 @@ public function setEnableLog($enable_log) /** * Gets envelope_events + * * @return string[] */ public function getEnvelopeEvents() @@ -457,7 +570,9 @@ 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. + * * @return $this */ public function setEnvelopeEvents($envelope_events) @@ -469,6 +584,7 @@ public function setEnvelopeEvents($envelope_events) /** * Gets event_data + * * @return \DocuSign\eSign\Model\ConnectEventData */ public function getEventData() @@ -478,7 +594,9 @@ public function getEventData() /** * Sets event_data - * @param \DocuSign\eSign\Model\ConnectEventData $event_data + * + * @param \DocuSign\eSign\Model\ConnectEventData $event_data event_data + * * @return $this */ public function setEventData($event_data) @@ -490,6 +608,7 @@ public function setEventData($event_data) /** * Gets external_folder_id + * * @return string */ public function getExternalFolderId() @@ -499,7 +618,9 @@ public function getExternalFolderId() /** * Sets external_folder_id + * * @param string $external_folder_id + * * @return $this */ public function setExternalFolderId($external_folder_id) @@ -511,6 +632,7 @@ public function setExternalFolderId($external_folder_id) /** * Gets external_folder_label + * * @return string */ public function getExternalFolderLabel() @@ -520,7 +642,9 @@ public function getExternalFolderLabel() /** * Sets external_folder_label + * * @param string $external_folder_label + * * @return $this */ public function setExternalFolderLabel($external_folder_label) @@ -532,6 +656,7 @@ public function setExternalFolderLabel($external_folder_label) /** * Gets include_certificate_of_completion + * * @return string */ public function getIncludeCertificateOfCompletion() @@ -541,7 +666,9 @@ public function getIncludeCertificateOfCompletion() /** * Sets include_certificate_of_completion + * * @param string $include_certificate_of_completion When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. + * * @return $this */ public function setIncludeCertificateOfCompletion($include_certificate_of_completion) @@ -553,6 +680,7 @@ public function setIncludeCertificateOfCompletion($include_certificate_of_comple /** * Gets include_cert_soap_header + * * @return string */ public function getIncludeCertSoapHeader() @@ -562,7 +690,9 @@ public function getIncludeCertSoapHeader() /** * Sets include_cert_soap_header + * * @param string $include_cert_soap_header + * * @return $this */ public function setIncludeCertSoapHeader($include_cert_soap_header) @@ -574,6 +704,7 @@ public function setIncludeCertSoapHeader($include_cert_soap_header) /** * Gets include_document_fields + * * @return string */ public function getIncludeDocumentFields() @@ -583,7 +714,9 @@ public function getIncludeDocumentFields() /** * Sets include_document_fields + * * @param string $include_document_fields When set to **true**, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API. + * * @return $this */ public function setIncludeDocumentFields($include_document_fields) @@ -595,6 +728,7 @@ public function setIncludeDocumentFields($include_document_fields) /** * Gets include_documents + * * @return string */ public function getIncludeDocuments() @@ -604,7 +738,9 @@ public function getIncludeDocuments() /** * Sets include_documents + * * @param string $include_documents When set to **true**, Connect will send the PDF document along with the update XML. + * * @return $this */ public function setIncludeDocuments($include_documents) @@ -616,6 +752,7 @@ public function setIncludeDocuments($include_documents) /** * Gets include_envelope_void_reason + * * @return string */ public function getIncludeEnvelopeVoidReason() @@ -625,7 +762,9 @@ public function getIncludeEnvelopeVoidReason() /** * Sets include_envelope_void_reason + * * @param string $include_envelope_void_reason When set to **true**, Connect will include the voidedReason for voided envelopes. + * * @return $this */ public function setIncludeEnvelopeVoidReason($include_envelope_void_reason) @@ -637,6 +776,7 @@ public function setIncludeEnvelopeVoidReason($include_envelope_void_reason) /** * Gets include_hmac + * * @return string */ public function getIncludeHmac() @@ -646,7 +786,9 @@ public function getIncludeHmac() /** * Sets include_hmac + * * @param string $include_hmac + * * @return $this */ public function setIncludeHmac($include_hmac) @@ -658,6 +800,7 @@ public function setIncludeHmac($include_hmac) /** * Gets include_sender_accountas_custom_field + * * @return string */ public function getIncludeSenderAccountasCustomField() @@ -667,7 +810,9 @@ public function getIncludeSenderAccountasCustomField() /** * Sets include_sender_accountas_custom_field + * * @param string $include_sender_accountas_custom_field When set to **true**, Connect will include the sender account as Custom Field in the data. + * * @return $this */ public function setIncludeSenderAccountasCustomField($include_sender_accountas_custom_field) @@ -679,6 +824,7 @@ public function setIncludeSenderAccountasCustomField($include_sender_accountas_c /** * Gets include_time_zone_information + * * @return string */ public function getIncludeTimeZoneInformation() @@ -688,7 +834,9 @@ public function getIncludeTimeZoneInformation() /** * Sets include_time_zone_information + * * @param string $include_time_zone_information When set to **true**, Connect will include the envelope time zone information. + * * @return $this */ public function setIncludeTimeZoneInformation($include_time_zone_information) @@ -700,6 +848,7 @@ public function setIncludeTimeZoneInformation($include_time_zone_information) /** * Gets name + * * @return string */ public function getName() @@ -709,7 +858,9 @@ public function getName() /** * Sets name + * * @param string $name The name of the Connect configuration. The name helps identify the configuration in the list. + * * @return $this */ public function setName($name) @@ -721,6 +872,7 @@ public function setName($name) /** * Gets password + * * @return string */ public function getPassword() @@ -730,7 +882,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -742,6 +896,7 @@ public function setPassword($password) /** * Gets recipient_events + * * @return string[] */ public function getRecipientEvents() @@ -751,7 +906,9 @@ 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. + * * @return $this */ public function setRecipientEvents($recipient_events) @@ -763,6 +920,7 @@ public function setRecipientEvents($recipient_events) /** * Gets require_mutual_tls + * * @return string */ public function getRequireMutualTls() @@ -772,7 +930,9 @@ public function getRequireMutualTls() /** * Sets require_mutual_tls + * * @param string $require_mutual_tls + * * @return $this */ public function setRequireMutualTls($require_mutual_tls) @@ -784,6 +944,7 @@ public function setRequireMutualTls($require_mutual_tls) /** * Gets requires_acknowledgement + * * @return string */ public function getRequiresAcknowledgement() @@ -793,7 +954,9 @@ public function getRequiresAcknowledgement() /** * Sets requires_acknowledgement + * * @param string $requires_acknowledgement When set to **true**, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information. + * * @return $this */ public function setRequiresAcknowledgement($requires_acknowledgement) @@ -805,6 +968,7 @@ public function setRequiresAcknowledgement($requires_acknowledgement) /** * Gets salesforce_api_version + * * @return string */ public function getSalesforceApiVersion() @@ -814,7 +978,9 @@ public function getSalesforceApiVersion() /** * Sets salesforce_api_version + * * @param string $salesforce_api_version + * * @return $this */ public function setSalesforceApiVersion($salesforce_api_version) @@ -826,6 +992,7 @@ public function setSalesforceApiVersion($salesforce_api_version) /** * Gets salesforce_authcode + * * @return string */ public function getSalesforceAuthcode() @@ -835,7 +1002,9 @@ public function getSalesforceAuthcode() /** * Sets salesforce_authcode + * * @param string $salesforce_authcode + * * @return $this */ public function setSalesforceAuthcode($salesforce_authcode) @@ -847,6 +1016,7 @@ public function setSalesforceAuthcode($salesforce_authcode) /** * Gets salesforce_call_back_url + * * @return string */ public function getSalesforceCallBackUrl() @@ -856,7 +1026,9 @@ public function getSalesforceCallBackUrl() /** * Sets salesforce_call_back_url + * * @param string $salesforce_call_back_url + * * @return $this */ public function setSalesforceCallBackUrl($salesforce_call_back_url) @@ -868,6 +1040,7 @@ public function setSalesforceCallBackUrl($salesforce_call_back_url) /** * Gets salesforce_documents_as_content_files + * * @return string */ public function getSalesforceDocumentsAsContentFiles() @@ -877,7 +1050,9 @@ public function getSalesforceDocumentsAsContentFiles() /** * Sets salesforce_documents_as_content_files + * * @param string $salesforce_documents_as_content_files + * * @return $this */ public function setSalesforceDocumentsAsContentFiles($salesforce_documents_as_content_files) @@ -889,6 +1064,7 @@ public function setSalesforceDocumentsAsContentFiles($salesforce_documents_as_co /** * Gets sender_override + * * @return string */ public function getSenderOverride() @@ -898,7 +1074,9 @@ public function getSenderOverride() /** * Sets sender_override + * * @param string $sender_override + * * @return $this */ public function setSenderOverride($sender_override) @@ -910,6 +1088,7 @@ public function setSenderOverride($sender_override) /** * Gets sender_selectable_items + * * @return string[] */ public function getSenderSelectableItems() @@ -919,7 +1098,9 @@ public function getSenderSelectableItems() /** * Sets sender_selectable_items + * * @param string[] $sender_selectable_items + * * @return $this */ public function setSenderSelectableItems($sender_selectable_items) @@ -931,6 +1112,7 @@ public function setSenderSelectableItems($sender_selectable_items) /** * Gets sf_objects + * * @return \DocuSign\eSign\Model\ConnectSalesforceObject[] */ public function getSfObjects() @@ -940,7 +1122,9 @@ public function getSfObjects() /** * Sets sf_objects + * * @param \DocuSign\eSign\Model\ConnectSalesforceObject[] $sf_objects + * * @return $this */ public function setSfObjects($sf_objects) @@ -952,6 +1136,7 @@ public function setSfObjects($sf_objects) /** * Gets sign_message_with_x509_certificate + * * @return string */ public function getSignMessageWithX509Certificate() @@ -961,7 +1146,9 @@ public function getSignMessageWithX509Certificate() /** * Sets sign_message_with_x509_certificate + * * @param string $sign_message_with_x509_certificate When set to **true**, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL. + * * @return $this */ public function setSignMessageWithX509Certificate($sign_message_with_x509_certificate) @@ -973,6 +1160,7 @@ public function setSignMessageWithX509Certificate($sign_message_with_x509_certif /** * Gets soap_namespace + * * @return string */ public function getSoapNamespace() @@ -982,7 +1170,9 @@ public function getSoapNamespace() /** * Sets soap_namespace + * * @param string $soap_namespace The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true. + * * @return $this */ public function setSoapNamespace($soap_namespace) @@ -994,6 +1184,7 @@ public function setSoapNamespace($soap_namespace) /** * Gets url_to_publish_to + * * @return string */ public function getUrlToPublishTo() @@ -1003,7 +1194,9 @@ public function getUrlToPublishTo() /** * Sets url_to_publish_to + * * @param string $url_to_publish_to This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. + * * @return $this */ public function setUrlToPublishTo($url_to_publish_to) @@ -1015,6 +1208,7 @@ public function setUrlToPublishTo($url_to_publish_to) /** * Gets user_ids + * * @return string[] */ public function getUserIds() @@ -1024,7 +1218,9 @@ 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. + * * @return $this */ public function setUserIds($user_ids) @@ -1036,6 +1232,7 @@ public function setUserIds($user_ids) /** * Gets user_name + * * @return string */ public function getUserName() @@ -1045,7 +1242,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -1057,6 +1256,7 @@ public function setUserName($user_name) /** * Gets use_soap_interface + * * @return string */ public function getUseSoapInterface() @@ -1066,7 +1266,9 @@ public function getUseSoapInterface() /** * Sets use_soap_interface + * * @param string $use_soap_interface When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint. + * * @return $this */ public function setUseSoapInterface($use_soap_interface) @@ -1077,7 +1279,9 @@ public function setUseSoapInterface($use_soap_interface) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1087,7 +1291,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1097,8 +1303,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1112,7 +1320,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1122,16 +1332,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectDebugLog.php b/src/Model/ConnectDebugLog.php index a77e4f6d..ca290d93 100644 --- a/src/Model/ConnectDebugLog.php +++ b/src/Model/ConnectDebugLog.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectDebugLog Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectDebugLog implements ArrayAccess +class ConnectDebugLog implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectDebugLog'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class ConnectDebugLog implements ArrayAccess 'payload' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'connect_config' => null, + 'error_details' => null, + 'event_date_time' => null, + 'event_description' => null, + 'payload' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'payload' => 'payload' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'payload' => 'setPayload' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'payload' => 'getPayload' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets connect_config + * * @return string */ public function getConnectConfig() @@ -176,7 +240,9 @@ public function getConnectConfig() /** * Sets connect_config + * * @param string $connect_config + * * @return $this */ public function setConnectConfig($connect_config) @@ -188,6 +254,7 @@ public function setConnectConfig($connect_config) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -197,7 +264,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -209,6 +278,7 @@ public function setErrorDetails($error_details) /** * Gets event_date_time + * * @return string */ public function getEventDateTime() @@ -218,7 +288,9 @@ public function getEventDateTime() /** * Sets event_date_time + * * @param string $event_date_time + * * @return $this */ public function setEventDateTime($event_date_time) @@ -230,6 +302,7 @@ public function setEventDateTime($event_date_time) /** * Gets event_description + * * @return string */ public function getEventDescription() @@ -239,7 +312,9 @@ public function getEventDescription() /** * Sets event_description + * * @param string $event_description + * * @return $this */ public function setEventDescription($event_description) @@ -251,6 +326,7 @@ public function setEventDescription($event_description) /** * Gets payload + * * @return string */ public function getPayload() @@ -260,7 +336,9 @@ public function getPayload() /** * Sets payload + * * @param string $payload + * * @return $this */ public function setPayload($payload) @@ -271,7 +349,9 @@ public function setPayload($payload) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectEventData.php b/src/Model/ConnectEventData.php index d5183846..247a4cdc 100644 --- a/src/Model/ConnectEventData.php +++ b/src/Model/ConnectEventData.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectEventData Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectEventData implements ArrayAccess +class ConnectEventData implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectEventData'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class ConnectEventData implements ArrayAccess 'version' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'format' => null, + 'include_data' => null, + 'version' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'version' => 'version' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'version' => 'setVersion' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'version' => 'getVersion' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets format + * * @return string */ public function getFormat() @@ -166,7 +228,9 @@ public function getFormat() /** * Sets format + * * @param string $format + * * @return $this */ public function setFormat($format) @@ -178,6 +242,7 @@ public function setFormat($format) /** * Gets include_data + * * @return string[] */ public function getIncludeData() @@ -187,7 +252,9 @@ public function getIncludeData() /** * Sets include_data + * * @param string[] $include_data + * * @return $this */ public function setIncludeData($include_data) @@ -199,6 +266,7 @@ public function setIncludeData($include_data) /** * Gets version + * * @return string */ public function getVersion() @@ -208,7 +276,9 @@ public function getVersion() /** * Sets version + * * @param string $version + * * @return $this */ public function setVersion($version) @@ -219,7 +289,9 @@ public function setVersion($version) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectFailureFilter.php b/src/Model/ConnectFailureFilter.php index b656a56d..87641e58 100644 --- a/src/Model/ConnectFailureFilter.php +++ b/src/Model/ConnectFailureFilter.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectFailureFilter Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectFailureFilter implements ArrayAccess +class ConnectFailureFilter implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectFailureFilter'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class ConnectFailureFilter implements ArrayAccess 'synchronous' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_ids' => null, + 'synchronous' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'synchronous' => 'synchronous' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'synchronous' => 'setSynchronous' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'synchronous' => 'getSynchronous' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_ids + * * @return string[] */ public function getEnvelopeIds() @@ -161,7 +222,9 @@ public function getEnvelopeIds() /** * Sets envelope_ids + * * @param string[] $envelope_ids + * * @return $this */ public function setEnvelopeIds($envelope_ids) @@ -173,6 +236,7 @@ public function setEnvelopeIds($envelope_ids) /** * Gets synchronous + * * @return string */ public function getSynchronous() @@ -182,7 +246,9 @@ public function getSynchronous() /** * Sets synchronous + * * @param string $synchronous + * * @return $this */ public function setSynchronous($synchronous) @@ -193,7 +259,9 @@ public function setSynchronous($synchronous) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectFailureResult.php b/src/Model/ConnectFailureResult.php index 5020d07b..3e3c10f1 100644 --- a/src/Model/ConnectFailureResult.php +++ b/src/Model/ConnectFailureResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectFailureResult Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectFailureResult implements ArrayAccess +class ConnectFailureResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectFailureResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class ConnectFailureResult implements ArrayAccess 'status_message' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'config_id' => null, + 'config_url' => null, + 'envelope_id' => null, + 'status' => null, + 'status_message' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'status_message' => 'statusMessage' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'status_message' => 'setStatusMessage' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'status_message' => 'getStatusMessage' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets config_id + * * @return string */ public function getConfigId() @@ -176,7 +240,9 @@ public function getConfigId() /** * Sets config_id + * * @param string $config_id Reserved: TBD + * * @return $this */ public function setConfigId($config_id) @@ -188,6 +254,7 @@ public function setConfigId($config_id) /** * Gets config_url + * * @return string */ public function getConfigUrl() @@ -197,7 +264,9 @@ public function getConfigUrl() /** * Sets config_url + * * @param string $config_url Reserved: TBD + * * @return $this */ public function setConfigUrl($config_url) @@ -209,6 +278,7 @@ public function setConfigUrl($config_url) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -218,7 +288,9 @@ public function getEnvelopeId() /** * 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) @@ -230,6 +302,7 @@ public function setEnvelopeId($envelope_id) /** * Gets status + * * @return string */ public function getStatus() @@ -239,7 +312,9 @@ public function getStatus() /** * 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) @@ -251,6 +326,7 @@ public function setStatus($status) /** * Gets status_message + * * @return string */ public function getStatusMessage() @@ -260,7 +336,9 @@ public function getStatusMessage() /** * Sets status_message + * * @param string $status_message + * * @return $this */ public function setStatusMessage($status_message) @@ -271,7 +349,9 @@ public function setStatusMessage($status_message) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectFailureResults.php b/src/Model/ConnectFailureResults.php index 7a1fb955..770876c0 100644 --- a/src/Model/ConnectFailureResults.php +++ b/src/Model/ConnectFailureResults.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectFailureResults Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectFailureResults implements ArrayAccess +class ConnectFailureResults implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectFailureResults'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'retry_queue' => '\DocuSign\eSign\Model\ConnectFailureResult[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'retry_queue' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'retry_queue' => 'retryQueue' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'retry_queue' => 'setRetryQueue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'retry_queue' => 'getRetryQueue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets retry_queue + * * @return \DocuSign\eSign\Model\ConnectFailureResult[] */ public function getRetryQueue() @@ -156,7 +216,9 @@ public function getRetryQueue() /** * Sets retry_queue + * * @param \DocuSign\eSign\Model\ConnectFailureResult[] $retry_queue + * * @return $this */ public function setRetryQueue($retry_queue) @@ -167,7 +229,9 @@ public function setRetryQueue($retry_queue) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectLog.php b/src/Model/ConnectLog.php index 4996540a..9337aa5f 100644 --- a/src/Model/ConnectLog.php +++ b/src/Model/ConnectLog.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectLog Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectLog implements ArrayAccess +class ConnectLog implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectLog'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -74,13 +77,56 @@ class ConnectLog implements ArrayAccess 'user_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_id' => null, + 'config_url' => null, + 'connect_debug_log' => null, + 'connect_id' => null, + 'created' => null, + 'email' => null, + 'envelope_id' => null, + 'error' => null, + 'failure_id' => null, + 'failure_uri' => null, + 'last_try' => null, + 'log_id' => null, + 'log_uri' => null, + 'retry_count' => null, + 'retry_uri' => null, + 'status' => null, + 'subject' => null, + 'user_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -104,9 +150,9 @@ public static function swaggerTypes() 'user_name' => 'userName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -130,9 +176,9 @@ public static function swaggerTypes() 'user_name' => 'setUserName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -156,34 +202,63 @@ public static function swaggerTypes() 'user_name' => 'getUserName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -208,30 +283,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_id + * * @return string */ public function getAccountId() @@ -241,7 +318,9 @@ public function getAccountId() /** * Sets account_id + * * @param string $account_id The account ID associated with the envelope. + * * @return $this */ public function setAccountId($account_id) @@ -253,6 +332,7 @@ public function setAccountId($account_id) /** * Gets config_url + * * @return string */ public function getConfigUrl() @@ -262,7 +342,9 @@ public function getConfigUrl() /** * Sets config_url + * * @param string $config_url The web address of the listener or Retrieving Service end point for Connect. + * * @return $this */ public function setConfigUrl($config_url) @@ -274,6 +356,7 @@ public function setConfigUrl($config_url) /** * Gets connect_debug_log + * * @return \DocuSign\eSign\Model\ConnectDebugLog[] */ public function getConnectDebugLog() @@ -283,7 +366,9 @@ public function getConnectDebugLog() /** * Sets connect_debug_log + * * @param \DocuSign\eSign\Model\ConnectDebugLog[] $connect_debug_log A complex element containing information about the Connect configuration, error details, date/time, description and payload. This is only included in the response if the query additional_info=true is used. + * * @return $this */ public function setConnectDebugLog($connect_debug_log) @@ -295,6 +380,7 @@ public function setConnectDebugLog($connect_debug_log) /** * Gets connect_id + * * @return string */ public function getConnectId() @@ -304,7 +390,9 @@ public function getConnectId() /** * Sets connect_id + * * @param string $connect_id The identifier for the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post. + * * @return $this */ public function setConnectId($connect_id) @@ -316,6 +404,7 @@ public function setConnectId($connect_id) /** * Gets created + * * @return string */ public function getCreated() @@ -325,7 +414,9 @@ public function getCreated() /** * Sets created + * * @param string $created The date and time the entry was created. + * * @return $this */ public function setCreated($created) @@ -337,6 +428,7 @@ public function setCreated($created) /** * Gets email + * * @return string */ public function getEmail() @@ -346,7 +438,9 @@ public function getEmail() /** * Sets email + * * @param string $email The email that sent the envelope. + * * @return $this */ public function setEmail($email) @@ -358,6 +452,7 @@ public function setEmail($email) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -367,7 +462,9 @@ public function getEnvelopeId() /** * 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) @@ -379,6 +476,7 @@ public function setEnvelopeId($envelope_id) /** * Gets error + * * @return string */ public function getError() @@ -388,7 +486,9 @@ public function getError() /** * Sets error + * * @param string $error The error that caused the Connect post to fail. + * * @return $this */ public function setError($error) @@ -400,6 +500,7 @@ public function setError($error) /** * Gets failure_id + * * @return string */ public function getFailureId() @@ -409,7 +510,9 @@ public function getFailureId() /** * Sets failure_id + * * @param string $failure_id The failure log ID for the failure. + * * @return $this */ public function setFailureId($failure_id) @@ -421,6 +524,7 @@ public function setFailureId($failure_id) /** * Gets failure_uri + * * @return string */ public function getFailureUri() @@ -430,7 +534,9 @@ public function getFailureUri() /** * Sets failure_uri + * * @param string $failure_uri The URI for the failure. + * * @return $this */ public function setFailureUri($failure_uri) @@ -442,6 +548,7 @@ public function setFailureUri($failure_uri) /** * Gets last_try + * * @return string */ public function getLastTry() @@ -451,7 +558,9 @@ public function getLastTry() /** * Sets last_try + * * @param string $last_try The date and time the last attempt to post. + * * @return $this */ public function setLastTry($last_try) @@ -463,6 +572,7 @@ public function setLastTry($last_try) /** * Gets log_id + * * @return string */ public function getLogId() @@ -472,7 +582,9 @@ public function getLogId() /** * Sets log_id + * * @param string $log_id The Connect log ID for the entry. + * * @return $this */ public function setLogId($log_id) @@ -484,6 +596,7 @@ public function setLogId($log_id) /** * Gets log_uri + * * @return string */ public function getLogUri() @@ -493,7 +606,9 @@ public function getLogUri() /** * Sets log_uri + * * @param string $log_uri The URI for the log item. + * * @return $this */ public function setLogUri($log_uri) @@ -505,6 +620,7 @@ public function setLogUri($log_uri) /** * Gets retry_count + * * @return string */ public function getRetryCount() @@ -514,7 +630,9 @@ public function getRetryCount() /** * Sets retry_count + * * @param string $retry_count The number of times the Connect post has been retried. + * * @return $this */ public function setRetryCount($retry_count) @@ -526,6 +644,7 @@ public function setRetryCount($retry_count) /** * Gets retry_uri + * * @return string */ public function getRetryUri() @@ -535,7 +654,9 @@ public function getRetryUri() /** * Sets retry_uri + * * @param string $retry_uri The UEI to retry to publish the Connect failure. + * * @return $this */ public function setRetryUri($retry_uri) @@ -547,6 +668,7 @@ public function setRetryUri($retry_uri) /** * Gets status + * * @return string */ public function getStatus() @@ -556,7 +678,9 @@ public function getStatus() /** * Sets status + * * @param string $status The new envelope status for the failed Connect post. The possible values are: Any, Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut, Template, or Processing. + * * @return $this */ public function setStatus($status) @@ -568,6 +692,7 @@ public function setStatus($status) /** * Gets subject + * * @return string */ public function getSubject() @@ -577,7 +702,9 @@ public function getSubject() /** * Sets subject + * * @param string $subject The envelope subject. + * * @return $this */ public function setSubject($subject) @@ -589,6 +716,7 @@ public function setSubject($subject) /** * Gets user_name + * * @return string */ public function getUserName() @@ -598,7 +726,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name The name of the envelope sender. + * * @return $this */ public function setUserName($user_name) @@ -609,7 +739,9 @@ public function setUserName($user_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -619,7 +751,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -629,8 +763,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -644,7 +780,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -654,16 +792,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectLogs.php b/src/Model/ConnectLogs.php index d5cda8d2..c183543b 100644 --- a/src/Model/ConnectLogs.php +++ b/src/Model/ConnectLogs.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectLogs Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectLogs implements ArrayAccess +class ConnectLogs implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectLogs'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class ConnectLogs implements ArrayAccess 'type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'failures' => null, + 'logs' => null, + 'total_records' => null, + 'type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'type' => 'type' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'type' => 'setType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'type' => 'getType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets failures + * * @return \DocuSign\eSign\Model\ConnectLog[] */ public function getFailures() @@ -171,7 +234,9 @@ public function getFailures() /** * Sets failures + * * @param \DocuSign\eSign\Model\ConnectLog[] $failures An array of containing failure information from the Connect failure log. + * * @return $this */ public function setFailures($failures) @@ -183,6 +248,7 @@ public function setFailures($failures) /** * Gets logs + * * @return \DocuSign\eSign\Model\ConnectLog[] */ public function getLogs() @@ -192,7 +258,9 @@ public function getLogs() /** * Sets logs + * * @param \DocuSign\eSign\Model\ConnectLog[] $logs A complex type containing Connect log information. It is divided into two sections, one for regular logs and one for Connect failures. + * * @return $this */ public function setLogs($logs) @@ -204,6 +272,7 @@ public function setLogs($logs) /** * Gets total_records + * * @return string */ public function getTotalRecords() @@ -213,7 +282,9 @@ public function getTotalRecords() /** * Sets total_records + * * @param string $total_records + * * @return $this */ public function setTotalRecords($total_records) @@ -225,6 +296,7 @@ public function setTotalRecords($total_records) /** * Gets type + * * @return string */ public function getType() @@ -234,7 +306,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -245,7 +319,9 @@ public function setType($type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectSalesforceField.php b/src/Model/ConnectSalesforceField.php index 9956a5f8..6bde37e1 100644 --- a/src/Model/ConnectSalesforceField.php +++ b/src/Model/ConnectSalesforceField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectSalesforceField Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectSalesforceField implements ArrayAccess +class ConnectSalesforceField implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectSalesforceField'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class ConnectSalesforceField implements ArrayAccess 'sf_locked_value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'ds_attribute' => null, + 'ds_link' => null, + 'ds_node' => null, + 'id' => null, + 'sf_field' => null, + 'sf_field_name' => null, + 'sf_folder' => null, + 'sf_locked_value' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'sf_locked_value' => 'sfLockedValue' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'sf_locked_value' => 'setSfLockedValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'sf_locked_value' => 'getSfLockedValue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets ds_attribute + * * @return string */ public function getDsAttribute() @@ -191,7 +258,9 @@ public function getDsAttribute() /** * Sets ds_attribute + * * @param string $ds_attribute + * * @return $this */ public function setDsAttribute($ds_attribute) @@ -203,6 +272,7 @@ public function setDsAttribute($ds_attribute) /** * Gets ds_link + * * @return string */ public function getDsLink() @@ -212,7 +282,9 @@ public function getDsLink() /** * Sets ds_link + * * @param string $ds_link + * * @return $this */ public function setDsLink($ds_link) @@ -224,6 +296,7 @@ public function setDsLink($ds_link) /** * Gets ds_node + * * @return string */ public function getDsNode() @@ -233,7 +306,9 @@ public function getDsNode() /** * Sets ds_node + * * @param string $ds_node + * * @return $this */ public function setDsNode($ds_node) @@ -245,6 +320,7 @@ public function setDsNode($ds_node) /** * Gets id + * * @return string */ public function getId() @@ -254,7 +330,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -266,6 +344,7 @@ public function setId($id) /** * Gets sf_field + * * @return string */ public function getSfField() @@ -275,7 +354,9 @@ public function getSfField() /** * Sets sf_field + * * @param string $sf_field + * * @return $this */ public function setSfField($sf_field) @@ -287,6 +368,7 @@ public function setSfField($sf_field) /** * Gets sf_field_name + * * @return string */ public function getSfFieldName() @@ -296,7 +378,9 @@ public function getSfFieldName() /** * Sets sf_field_name + * * @param string $sf_field_name + * * @return $this */ public function setSfFieldName($sf_field_name) @@ -308,6 +392,7 @@ public function setSfFieldName($sf_field_name) /** * Gets sf_folder + * * @return string */ public function getSfFolder() @@ -317,7 +402,9 @@ public function getSfFolder() /** * Sets sf_folder + * * @param string $sf_folder + * * @return $this */ public function setSfFolder($sf_folder) @@ -329,6 +416,7 @@ public function setSfFolder($sf_folder) /** * Gets sf_locked_value + * * @return string */ public function getSfLockedValue() @@ -338,7 +426,9 @@ public function getSfLockedValue() /** * Sets sf_locked_value + * * @param string $sf_locked_value + * * @return $this */ public function setSfLockedValue($sf_locked_value) @@ -349,7 +439,9 @@ public function setSfLockedValue($sf_locked_value) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectSalesforceObject.php b/src/Model/ConnectSalesforceObject.php index 14df2856..f51df378 100644 --- a/src/Model/ConnectSalesforceObject.php +++ b/src/Model/ConnectSalesforceObject.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectSalesforceObject Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectSalesforceObject implements ArrayAccess +class ConnectSalesforceObject implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectSalesforceObject'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,47 @@ class ConnectSalesforceObject implements ArrayAccess 'update_fields' => '\DocuSign\eSign\Model\ConnectSalesforceField[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'active' => null, + 'description' => null, + 'id' => null, + 'insert' => null, + 'on_complete_only' => null, + 'select_fields' => null, + 'sf_object' => null, + 'sf_object_name' => null, + 'update_fields' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -86,9 +123,9 @@ public static function swaggerTypes() 'update_fields' => 'updateFields' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -103,9 +140,9 @@ public static function swaggerTypes() 'update_fields' => 'setUpdateFields' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -120,34 +157,63 @@ public static function swaggerTypes() 'update_fields' => 'getUpdateFields' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -163,30 +229,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets active + * * @return string */ public function getActive() @@ -196,7 +264,9 @@ public function getActive() /** * Sets active + * * @param string $active + * * @return $this */ public function setActive($active) @@ -208,6 +278,7 @@ public function setActive($active) /** * Gets description + * * @return string */ public function getDescription() @@ -217,7 +288,9 @@ public function getDescription() /** * Sets description + * * @param string $description + * * @return $this */ public function setDescription($description) @@ -229,6 +302,7 @@ public function setDescription($description) /** * Gets id + * * @return string */ public function getId() @@ -238,7 +312,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -250,6 +326,7 @@ public function setId($id) /** * Gets insert + * * @return string */ public function getInsert() @@ -259,7 +336,9 @@ public function getInsert() /** * Sets insert + * * @param string $insert + * * @return $this */ public function setInsert($insert) @@ -271,6 +350,7 @@ public function setInsert($insert) /** * Gets on_complete_only + * * @return string */ public function getOnCompleteOnly() @@ -280,7 +360,9 @@ public function getOnCompleteOnly() /** * Sets on_complete_only + * * @param string $on_complete_only + * * @return $this */ public function setOnCompleteOnly($on_complete_only) @@ -292,6 +374,7 @@ public function setOnCompleteOnly($on_complete_only) /** * Gets select_fields + * * @return \DocuSign\eSign\Model\ConnectSalesforceField[] */ public function getSelectFields() @@ -301,7 +384,9 @@ public function getSelectFields() /** * Sets select_fields + * * @param \DocuSign\eSign\Model\ConnectSalesforceField[] $select_fields + * * @return $this */ public function setSelectFields($select_fields) @@ -313,6 +398,7 @@ public function setSelectFields($select_fields) /** * Gets sf_object + * * @return string */ public function getSfObject() @@ -322,7 +408,9 @@ public function getSfObject() /** * Sets sf_object + * * @param string $sf_object + * * @return $this */ public function setSfObject($sf_object) @@ -334,6 +422,7 @@ public function setSfObject($sf_object) /** * Gets sf_object_name + * * @return string */ public function getSfObjectName() @@ -343,7 +432,9 @@ public function getSfObjectName() /** * Sets sf_object_name + * * @param string $sf_object_name + * * @return $this */ public function setSfObjectName($sf_object_name) @@ -355,6 +446,7 @@ public function setSfObjectName($sf_object_name) /** * Gets update_fields + * * @return \DocuSign\eSign\Model\ConnectSalesforceField[] */ public function getUpdateFields() @@ -364,7 +456,9 @@ public function getUpdateFields() /** * Sets update_fields + * * @param \DocuSign\eSign\Model\ConnectSalesforceField[] $update_fields + * * @return $this */ public function setUpdateFields($update_fields) @@ -375,7 +469,9 @@ public function setUpdateFields($update_fields) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -385,7 +481,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -395,8 +493,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -410,7 +510,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -420,16 +522,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConnectUserObject.php b/src/Model/ConnectUserObject.php index 4874cf53..43fd04b2 100644 --- a/src/Model/ConnectUserObject.php +++ b/src/Model/ConnectUserObject.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConnectUserObject Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConnectUserObject implements ArrayAccess +class ConnectUserObject implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'connectUserObject'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class ConnectUserObject implements ArrayAccess 'sender_searchable_items' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'configurationtype' => null, + 'connect_id' => null, + 'enabled' => null, + 'has_access' => null, + 'sender_searchable_items' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'sender_searchable_items' => 'senderSearchableItems' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'sender_searchable_items' => 'setSenderSearchableItems' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'sender_searchable_items' => 'getSenderSearchableItems' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets configurationtype + * * @return string */ public function getConfigurationtype() @@ -176,7 +240,9 @@ public function getConfigurationtype() /** * Sets configurationtype + * * @param string $configurationtype If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. + * * @return $this */ public function setConfigurationtype($configurationtype) @@ -188,6 +254,7 @@ public function setConfigurationtype($configurationtype) /** * Gets connect_id + * * @return string */ public function getConnectId() @@ -197,7 +264,9 @@ public function getConnectId() /** * Sets connect_id + * * @param string $connect_id + * * @return $this */ public function setConnectId($connect_id) @@ -209,6 +278,7 @@ public function setConnectId($connect_id) /** * Gets enabled + * * @return string */ public function getEnabled() @@ -218,7 +288,9 @@ public function getEnabled() /** * Sets enabled + * * @param string $enabled + * * @return $this */ public function setEnabled($enabled) @@ -230,6 +302,7 @@ public function setEnabled($enabled) /** * Gets has_access + * * @return string */ public function getHasAccess() @@ -239,7 +312,9 @@ public function getHasAccess() /** * Sets has_access + * * @param string $has_access + * * @return $this */ public function setHasAccess($has_access) @@ -251,6 +326,7 @@ public function setHasAccess($has_access) /** * Gets sender_searchable_items + * * @return string[] */ public function getSenderSearchableItems() @@ -260,7 +336,9 @@ public function getSenderSearchableItems() /** * Sets sender_searchable_items + * * @param string[] $sender_searchable_items + * * @return $this */ public function setSenderSearchableItems($sender_searchable_items) @@ -271,7 +349,9 @@ public function setSenderSearchableItems($sender_searchable_items) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConsoleViewRequest.php b/src/Model/ConsoleViewRequest.php index bf3e394d..20a5a485 100644 --- a/src/Model/ConsoleViewRequest.php +++ b/src/Model/ConsoleViewRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConsoleViewRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConsoleViewRequest implements ArrayAccess +class ConsoleViewRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'consoleViewRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class ConsoleViewRequest implements ArrayAccess 'return_url' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_id' => null, + 'return_url' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'return_url' => 'returnUrl' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'return_url' => 'setReturnUrl' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'return_url' => 'getReturnUrl' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -161,7 +222,9 @@ public function getEnvelopeId() /** * 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) @@ -173,6 +236,7 @@ public function setEnvelopeId($envelope_id) /** * Gets return_url + * * @return string */ public function getReturnUrl() @@ -182,7 +246,9 @@ public function getReturnUrl() /** * Sets return_url + * * @param string $return_url The URL to be redirected to after the console view session has ended. + * * @return $this */ public function setReturnUrl($return_url) @@ -193,7 +259,9 @@ public function setReturnUrl($return_url) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ConsumerDisclosure.php b/src/Model/ConsumerDisclosure.php index 77c9601e..2acfebfd 100644 --- a/src/Model/ConsumerDisclosure.php +++ b/src/Model/ConsumerDisclosure.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ConsumerDisclosure Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ConsumerDisclosure implements ArrayAccess +class ConsumerDisclosure implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'consumerDisclosure'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -88,13 +91,70 @@ class ConsumerDisclosure implements ArrayAccess 'withdraw_state' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_esign_id' => null, + 'allow_cd_withdraw' => null, + 'allow_cd_withdraw_metadata' => null, + 'change_email' => null, + 'change_email_other' => null, + 'company_name' => null, + 'company_phone' => null, + 'copy_cost_per_page' => null, + 'copy_fee_collection_method' => null, + 'copy_request_email' => null, + 'custom' => null, + 'enable_esign' => null, + 'esign_agreement' => null, + 'esign_text' => null, + 'language_code' => null, + 'must_agree_to_esign' => null, + 'pdf_id' => null, + 'use_brand' => null, + 'use_consumer_disclosure_within_account' => null, + 'use_consumer_disclosure_within_account_metadata' => null, + 'withdraw_address_line1' => null, + 'withdraw_address_line2' => null, + 'withdraw_by_email' => null, + 'withdraw_by_mail' => null, + 'withdraw_by_phone' => null, + 'withdraw_city' => null, + 'withdraw_consequences' => null, + 'withdraw_email' => null, + 'withdraw_other' => null, + 'withdraw_phone' => null, + 'withdraw_postal_code' => null, + 'withdraw_state' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -132,9 +192,9 @@ public static function swaggerTypes() 'withdraw_state' => 'withdrawState' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -172,9 +232,9 @@ public static function swaggerTypes() 'withdraw_state' => 'setWithdrawState' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -212,34 +272,63 @@ public static function swaggerTypes() 'withdraw_state' => 'getWithdrawState' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -278,30 +367,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_esign_id + * * @return string */ public function getAccountEsignId() @@ -311,7 +402,9 @@ public function getAccountEsignId() /** * Sets account_esign_id + * * @param string $account_esign_id A GUID identifying the account associated with the consumer disclosure + * * @return $this */ public function setAccountEsignId($account_esign_id) @@ -323,6 +416,7 @@ public function setAccountEsignId($account_esign_id) /** * Gets allow_cd_withdraw + * * @return string */ public function getAllowCdWithdraw() @@ -332,7 +426,9 @@ public function getAllowCdWithdraw() /** * Sets allow_cd_withdraw + * * @param string $allow_cd_withdraw Indicates whether the customer can withdraw their acceptance of the consumer disclosure. + * * @return $this */ public function setAllowCdWithdraw($allow_cd_withdraw) @@ -344,6 +440,7 @@ public function setAllowCdWithdraw($allow_cd_withdraw) /** * Gets allow_cd_withdraw_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowCdWithdrawMetadata() @@ -353,7 +450,9 @@ public function getAllowCdWithdrawMetadata() /** * Sets allow_cd_withdraw_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_cd_withdraw_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_cd_withdraw_metadata allow_cd_withdraw_metadata + * * @return $this */ public function setAllowCdWithdrawMetadata($allow_cd_withdraw_metadata) @@ -365,6 +464,7 @@ public function setAllowCdWithdrawMetadata($allow_cd_withdraw_metadata) /** * Gets change_email + * * @return string */ public function getChangeEmail() @@ -374,7 +474,9 @@ public function getChangeEmail() /** * Sets change_email + * * @param string $change_email + * * @return $this */ public function setChangeEmail($change_email) @@ -386,6 +488,7 @@ public function setChangeEmail($change_email) /** * Gets change_email_other + * * @return string */ public function getChangeEmailOther() @@ -395,7 +498,9 @@ public function getChangeEmailOther() /** * Sets change_email_other + * * @param string $change_email_other + * * @return $this */ public function setChangeEmailOther($change_email_other) @@ -407,6 +512,7 @@ public function setChangeEmailOther($change_email_other) /** * Gets company_name + * * @return string */ public function getCompanyName() @@ -416,7 +522,9 @@ public function getCompanyName() /** * Sets company_name + * * @param string $company_name The name of the company associated with the consumer disclosure. + * * @return $this */ public function setCompanyName($company_name) @@ -428,6 +536,7 @@ public function setCompanyName($company_name) /** * Gets company_phone + * * @return string */ public function getCompanyPhone() @@ -437,7 +546,9 @@ public function getCompanyPhone() /** * Sets company_phone + * * @param string $company_phone The phone number of the company associated with the consumer disclosure. + * * @return $this */ public function setCompanyPhone($company_phone) @@ -449,6 +560,7 @@ public function setCompanyPhone($company_phone) /** * Gets copy_cost_per_page + * * @return string */ public function getCopyCostPerPage() @@ -458,7 +570,9 @@ public function getCopyCostPerPage() /** * Sets copy_cost_per_page + * * @param string $copy_cost_per_page + * * @return $this */ public function setCopyCostPerPage($copy_cost_per_page) @@ -470,6 +584,7 @@ public function setCopyCostPerPage($copy_cost_per_page) /** * Gets copy_fee_collection_method + * * @return string */ public function getCopyFeeCollectionMethod() @@ -479,7 +594,9 @@ public function getCopyFeeCollectionMethod() /** * Sets copy_fee_collection_method + * * @param string $copy_fee_collection_method Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum Length: 255 characters + * * @return $this */ public function setCopyFeeCollectionMethod($copy_fee_collection_method) @@ -491,6 +608,7 @@ public function setCopyFeeCollectionMethod($copy_fee_collection_method) /** * Gets copy_request_email + * * @return string */ public function getCopyRequestEmail() @@ -500,7 +618,9 @@ public function getCopyRequestEmail() /** * Sets copy_request_email + * * @param string $copy_request_email + * * @return $this */ public function setCopyRequestEmail($copy_request_email) @@ -512,6 +632,7 @@ public function setCopyRequestEmail($copy_request_email) /** * Gets custom + * * @return string */ public function getCustom() @@ -521,7 +642,9 @@ public function getCustom() /** * Sets custom + * * @param string $custom + * * @return $this */ public function setCustom($custom) @@ -533,6 +656,7 @@ public function setCustom($custom) /** * Gets enable_esign + * * @return string */ public function getEnableEsign() @@ -542,7 +666,9 @@ public function getEnableEsign() /** * Sets enable_esign + * * @param string $enable_esign + * * @return $this */ public function setEnableEsign($enable_esign) @@ -554,6 +680,7 @@ public function setEnableEsign($enable_esign) /** * Gets esign_agreement + * * @return string */ public function getEsignAgreement() @@ -563,7 +690,9 @@ public function getEsignAgreement() /** * Sets esign_agreement + * * @param string $esign_agreement The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting. + * * @return $this */ public function setEsignAgreement($esign_agreement) @@ -575,6 +704,7 @@ public function setEsignAgreement($esign_agreement) /** * Gets esign_text + * * @return string */ public function getEsignText() @@ -584,7 +714,9 @@ public function getEsignText() /** * Sets esign_text + * * @param string $esign_text + * * @return $this */ public function setEsignText($esign_text) @@ -596,6 +728,7 @@ public function setEsignText($esign_text) /** * Gets language_code + * * @return string */ public function getLanguageCode() @@ -605,7 +738,9 @@ public function getLanguageCode() /** * Sets language_code + * * @param string $language_code + * * @return $this */ public function setLanguageCode($language_code) @@ -617,6 +752,7 @@ public function setLanguageCode($language_code) /** * Gets must_agree_to_esign + * * @return string */ public function getMustAgreeToEsign() @@ -626,7 +762,9 @@ public function getMustAgreeToEsign() /** * Sets must_agree_to_esign + * * @param string $must_agree_to_esign + * * @return $this */ public function setMustAgreeToEsign($must_agree_to_esign) @@ -638,6 +776,7 @@ public function setMustAgreeToEsign($must_agree_to_esign) /** * Gets pdf_id + * * @return string */ public function getPdfId() @@ -647,7 +786,9 @@ public function getPdfId() /** * Sets pdf_id + * * @param string $pdf_id + * * @return $this */ public function setPdfId($pdf_id) @@ -659,6 +800,7 @@ public function setPdfId($pdf_id) /** * Gets use_brand + * * @return string */ public function getUseBrand() @@ -668,7 +810,9 @@ public function getUseBrand() /** * Sets use_brand + * * @param string $use_brand + * * @return $this */ public function setUseBrand($use_brand) @@ -680,6 +824,7 @@ public function setUseBrand($use_brand) /** * Gets use_consumer_disclosure_within_account + * * @return string */ public function getUseConsumerDisclosureWithinAccount() @@ -689,7 +834,9 @@ public function getUseConsumerDisclosureWithinAccount() /** * Sets use_consumer_disclosure_within_account + * * @param string $use_consumer_disclosure_within_account + * * @return $this */ public function setUseConsumerDisclosureWithinAccount($use_consumer_disclosure_within_account) @@ -701,6 +848,7 @@ public function setUseConsumerDisclosureWithinAccount($use_consumer_disclosure_w /** * Gets use_consumer_disclosure_within_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseConsumerDisclosureWithinAccountMetadata() @@ -710,7 +858,9 @@ public function getUseConsumerDisclosureWithinAccountMetadata() /** * Sets use_consumer_disclosure_within_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $use_consumer_disclosure_within_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $use_consumer_disclosure_within_account_metadata use_consumer_disclosure_within_account_metadata + * * @return $this */ public function setUseConsumerDisclosureWithinAccountMetadata($use_consumer_disclosure_within_account_metadata) @@ -722,6 +872,7 @@ public function setUseConsumerDisclosureWithinAccountMetadata($use_consumer_disc /** * Gets withdraw_address_line1 + * * @return string */ public function getWithdrawAddressLine1() @@ -731,7 +882,9 @@ public function getWithdrawAddressLine1() /** * Sets withdraw_address_line1 + * * @param string $withdraw_address_line1 Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. + * * @return $this */ public function setWithdrawAddressLine1($withdraw_address_line1) @@ -743,6 +896,7 @@ public function setWithdrawAddressLine1($withdraw_address_line1) /** * Gets withdraw_address_line2 + * * @return string */ public function getWithdrawAddressLine2() @@ -752,7 +906,9 @@ public function getWithdrawAddressLine2() /** * Sets withdraw_address_line2 + * * @param string $withdraw_address_line2 Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. + * * @return $this */ public function setWithdrawAddressLine2($withdraw_address_line2) @@ -764,6 +920,7 @@ public function setWithdrawAddressLine2($withdraw_address_line2) /** * Gets withdraw_by_email + * * @return string */ public function getWithdrawByEmail() @@ -773,7 +930,9 @@ public function getWithdrawByEmail() /** * Sets withdraw_by_email + * * @param string $withdraw_by_email Indicates whether the customer can withdraw consent by email. + * * @return $this */ public function setWithdrawByEmail($withdraw_by_email) @@ -785,6 +944,7 @@ public function setWithdrawByEmail($withdraw_by_email) /** * Gets withdraw_by_mail + * * @return string */ public function getWithdrawByMail() @@ -794,7 +954,9 @@ public function getWithdrawByMail() /** * Sets withdraw_by_mail + * * @param string $withdraw_by_mail Indicates whether the customer can withdraw consent by postal mail. + * * @return $this */ public function setWithdrawByMail($withdraw_by_mail) @@ -806,6 +968,7 @@ public function setWithdrawByMail($withdraw_by_mail) /** * Gets withdraw_by_phone + * * @return string */ public function getWithdrawByPhone() @@ -815,7 +978,9 @@ public function getWithdrawByPhone() /** * Sets withdraw_by_phone + * * @param string $withdraw_by_phone Indicates whether the customer can withdraw consent by phone. + * * @return $this */ public function setWithdrawByPhone($withdraw_by_phone) @@ -827,6 +992,7 @@ public function setWithdrawByPhone($withdraw_by_phone) /** * Gets withdraw_city + * * @return string */ public function getWithdrawCity() @@ -836,7 +1002,9 @@ public function getWithdrawCity() /** * Sets withdraw_city + * * @param string $withdraw_city Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters. + * * @return $this */ public function setWithdrawCity($withdraw_city) @@ -848,6 +1016,7 @@ public function setWithdrawCity($withdraw_city) /** * Gets withdraw_consequences + * * @return string */ public function getWithdrawConsequences() @@ -857,7 +1026,9 @@ public function getWithdrawConsequences() /** * Sets withdraw_consequences + * * @param string $withdraw_consequences Indicates the consequences of withdrawing consent. + * * @return $this */ public function setWithdrawConsequences($withdraw_consequences) @@ -869,6 +1040,7 @@ public function setWithdrawConsequences($withdraw_consequences) /** * Gets withdraw_email + * * @return string */ public function getWithdrawEmail() @@ -878,7 +1050,9 @@ public function getWithdrawEmail() /** * Sets withdraw_email + * * @param string $withdraw_email Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. + * * @return $this */ public function setWithdrawEmail($withdraw_email) @@ -890,6 +1064,7 @@ public function setWithdrawEmail($withdraw_email) /** * Gets withdraw_other + * * @return string */ public function getWithdrawOther() @@ -899,7 +1074,9 @@ public function getWithdrawOther() /** * Sets withdraw_other + * * @param string $withdraw_other Indicates other information need to withdraw consent. Maximum length: 255 characters. + * * @return $this */ public function setWithdrawOther($withdraw_other) @@ -911,6 +1088,7 @@ public function setWithdrawOther($withdraw_other) /** * Gets withdraw_phone + * * @return string */ public function getWithdrawPhone() @@ -920,7 +1098,9 @@ public function getWithdrawPhone() /** * Sets withdraw_phone + * * @param string $withdraw_phone Contains the phone number which a customer can call to register consent withdrawal notification. Maximum length: 20 characters. + * * @return $this */ public function setWithdrawPhone($withdraw_phone) @@ -932,6 +1112,7 @@ public function setWithdrawPhone($withdraw_phone) /** * Gets withdraw_postal_code + * * @return string */ public function getWithdrawPostalCode() @@ -941,7 +1122,9 @@ public function getWithdrawPostalCode() /** * Sets withdraw_postal_code + * * @param string $withdraw_postal_code Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters. + * * @return $this */ public function setWithdrawPostalCode($withdraw_postal_code) @@ -953,6 +1136,7 @@ public function setWithdrawPostalCode($withdraw_postal_code) /** * Gets withdraw_state + * * @return string */ public function getWithdrawState() @@ -962,7 +1146,9 @@ public function getWithdrawState() /** * Sets withdraw_state + * * @param string $withdraw_state Contains the state of the postal address to which a customer can send a consent withdrawal notification. + * * @return $this */ public function setWithdrawState($withdraw_state) @@ -973,7 +1159,9 @@ public function setWithdrawState($withdraw_state) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -983,7 +1171,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -993,8 +1183,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1008,7 +1200,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1018,16 +1212,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Contact.php b/src/Model/Contact.php index abb352a3..29c661ed 100644 --- a/src/Model/Contact.php +++ b/src/Model/Contact.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Contact Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Contact implements ArrayAccess +class Contact implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'contact'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -69,13 +72,51 @@ class Contact implements ArrayAccess 'signing_group_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'cloud_provider' => null, + 'cloud_provider_container_id' => null, + 'contact_id' => null, + 'contact_phone_numbers' => null, + 'contact_uri' => null, + 'emails' => null, + 'error_details' => null, + 'is_owner' => null, + 'name' => null, + 'organization' => null, + 'shared' => null, + 'signing_group' => null, + 'signing_group_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -94,9 +135,9 @@ public static function swaggerTypes() 'signing_group_name' => 'signingGroupName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -115,9 +156,9 @@ public static function swaggerTypes() 'signing_group_name' => 'setSigningGroupName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -136,34 +177,63 @@ public static function swaggerTypes() 'signing_group_name' => 'getSigningGroupName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -183,30 +253,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets cloud_provider + * * @return string */ public function getCloudProvider() @@ -216,7 +288,9 @@ public function getCloudProvider() /** * Sets cloud_provider + * * @param string $cloud_provider + * * @return $this */ public function setCloudProvider($cloud_provider) @@ -228,6 +302,7 @@ public function setCloudProvider($cloud_provider) /** * Gets cloud_provider_container_id + * * @return string */ public function getCloudProviderContainerId() @@ -237,7 +312,9 @@ public function getCloudProviderContainerId() /** * Sets cloud_provider_container_id + * * @param string $cloud_provider_container_id + * * @return $this */ public function setCloudProviderContainerId($cloud_provider_container_id) @@ -249,6 +326,7 @@ public function setCloudProviderContainerId($cloud_provider_container_id) /** * Gets contact_id + * * @return string */ public function getContactId() @@ -258,7 +336,9 @@ public function getContactId() /** * Sets contact_id + * * @param string $contact_id + * * @return $this */ public function setContactId($contact_id) @@ -270,6 +350,7 @@ public function setContactId($contact_id) /** * Gets contact_phone_numbers + * * @return \DocuSign\eSign\Model\ContactPhoneNumber[] */ public function getContactPhoneNumbers() @@ -279,7 +360,9 @@ public function getContactPhoneNumbers() /** * Sets contact_phone_numbers + * * @param \DocuSign\eSign\Model\ContactPhoneNumber[] $contact_phone_numbers + * * @return $this */ public function setContactPhoneNumbers($contact_phone_numbers) @@ -291,6 +374,7 @@ public function setContactPhoneNumbers($contact_phone_numbers) /** * Gets contact_uri + * * @return string */ public function getContactUri() @@ -300,7 +384,9 @@ public function getContactUri() /** * Sets contact_uri + * * @param string $contact_uri + * * @return $this */ public function setContactUri($contact_uri) @@ -312,6 +398,7 @@ public function setContactUri($contact_uri) /** * Gets emails + * * @return string[] */ public function getEmails() @@ -321,7 +408,9 @@ public function getEmails() /** * Sets emails + * * @param string[] $emails + * * @return $this */ public function setEmails($emails) @@ -333,6 +422,7 @@ public function setEmails($emails) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -342,7 +432,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -354,6 +446,7 @@ public function setErrorDetails($error_details) /** * Gets is_owner + * * @return bool */ public function getIsOwner() @@ -363,7 +456,9 @@ public function getIsOwner() /** * Sets is_owner + * * @param bool $is_owner + * * @return $this */ public function setIsOwner($is_owner) @@ -375,6 +470,7 @@ public function setIsOwner($is_owner) /** * Gets name + * * @return string */ public function getName() @@ -384,7 +480,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -396,6 +494,7 @@ public function setName($name) /** * Gets organization + * * @return string */ public function getOrganization() @@ -405,7 +504,9 @@ public function getOrganization() /** * Sets organization + * * @param string $organization + * * @return $this */ public function setOrganization($organization) @@ -417,6 +518,7 @@ public function setOrganization($organization) /** * Gets shared + * * @return string */ public function getShared() @@ -426,7 +528,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -438,6 +542,7 @@ public function setShared($shared) /** * Gets signing_group + * * @return string */ public function getSigningGroup() @@ -447,7 +552,9 @@ public function getSigningGroup() /** * Sets signing_group + * * @param string $signing_group + * * @return $this */ public function setSigningGroup($signing_group) @@ -459,6 +566,7 @@ public function setSigningGroup($signing_group) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -468,7 +576,9 @@ public function getSigningGroupName() /** * 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) @@ -479,7 +589,9 @@ public function setSigningGroupName($signing_group_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -489,7 +601,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -499,8 +613,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -514,7 +630,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -524,16 +642,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ContactGetResponse.php b/src/Model/ContactGetResponse.php index dcbdf146..f0d0bdeb 100644 --- a/src/Model/ContactGetResponse.php +++ b/src/Model/ContactGetResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ContactGetResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ContactGetResponse implements ArrayAccess +class ContactGetResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'contactGetResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class ContactGetResponse implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'contacts' => null, + 'end_position' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets contacts + * * @return \DocuSign\eSign\Model\Contact[] */ public function getContacts() @@ -186,7 +252,9 @@ public function getContacts() /** * Sets contacts + * * @param \DocuSign\eSign\Model\Contact[] $contacts + * * @return $this */ public function setContacts($contacts) @@ -198,6 +266,7 @@ public function setContacts($contacts) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -207,7 +276,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -219,6 +290,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -228,7 +300,9 @@ public function getNextUri() /** * 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) @@ -240,6 +314,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ContactModRequest.php b/src/Model/ContactModRequest.php index b057c330..e57bf100 100644 --- a/src/Model/ContactModRequest.php +++ b/src/Model/ContactModRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ContactModRequest Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ContactModRequest implements ArrayAccess +class ContactModRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'contactModRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'contact_list' => '\DocuSign\eSign\Model\Contact[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'contact_list' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'contact_list' => 'contactList' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'contact_list' => 'setContactList' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'contact_list' => 'getContactList' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets contact_list + * * @return \DocuSign\eSign\Model\Contact[] */ public function getContactList() @@ -156,7 +216,9 @@ public function getContactList() /** * Sets contact_list + * * @param \DocuSign\eSign\Model\Contact[] $contact_list + * * @return $this */ public function setContactList($contact_list) @@ -167,7 +229,9 @@ public function setContactList($contact_list) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ContactPhoneNumber.php b/src/Model/ContactPhoneNumber.php index 681128db..7822abbf 100644 --- a/src/Model/ContactPhoneNumber.php +++ b/src/Model/ContactPhoneNumber.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ContactPhoneNumber Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ContactPhoneNumber implements ArrayAccess +class ContactPhoneNumber implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'contactPhoneNumber'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class ContactPhoneNumber implements ArrayAccess 'phone_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'phone_number' => null, + 'phone_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'phone_type' => 'phoneType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'phone_type' => 'setPhoneType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'phone_type' => 'getPhoneType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets phone_number + * * @return string */ public function getPhoneNumber() @@ -161,7 +222,9 @@ public function getPhoneNumber() /** * Sets phone_number + * * @param string $phone_number + * * @return $this */ public function setPhoneNumber($phone_number) @@ -173,6 +236,7 @@ public function setPhoneNumber($phone_number) /** * Gets phone_type + * * @return string */ public function getPhoneType() @@ -182,7 +246,9 @@ public function getPhoneType() /** * Sets phone_type + * * @param string $phone_type + * * @return $this */ public function setPhoneType($phone_type) @@ -193,7 +259,9 @@ public function setPhoneType($phone_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ContactUpdateResponse.php b/src/Model/ContactUpdateResponse.php index e5006fb0..85fd7504 100644 --- a/src/Model/ContactUpdateResponse.php +++ b/src/Model/ContactUpdateResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ContactUpdateResponse Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ContactUpdateResponse implements ArrayAccess +class ContactUpdateResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'contactUpdateResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'contacts' => '\DocuSign\eSign\Model\Contact[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'contacts' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'contacts' => 'contacts' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'contacts' => 'setContacts' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'contacts' => 'getContacts' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets contacts + * * @return \DocuSign\eSign\Model\Contact[] */ public function getContacts() @@ -156,7 +216,9 @@ public function getContacts() /** * Sets contacts + * * @param \DocuSign\eSign\Model\Contact[] $contacts + * * @return $this */ public function setContacts($contacts) @@ -167,7 +229,9 @@ public function setContacts($contacts) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CorrectViewRequest.php b/src/Model/CorrectViewRequest.php index 9f2b108c..e0862327 100644 --- a/src/Model/CorrectViewRequest.php +++ b/src/Model/CorrectViewRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CorrectViewRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CorrectViewRequest implements ArrayAccess +class CorrectViewRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'correctViewRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class CorrectViewRequest implements ArrayAccess 'suppress_navigation' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'return_url' => null, + 'suppress_navigation' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'suppress_navigation' => 'suppressNavigation' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'suppress_navigation' => 'setSuppressNavigation' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'suppress_navigation' => 'getSuppressNavigation' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets return_url + * * @return string */ public function getReturnUrl() @@ -161,7 +222,9 @@ public function getReturnUrl() /** * Sets return_url + * * @param string $return_url The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are: * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. + * * @return $this */ public function setReturnUrl($return_url) @@ -173,6 +236,7 @@ public function setReturnUrl($return_url) /** * Gets suppress_navigation + * * @return string */ public function getSuppressNavigation() @@ -182,7 +246,9 @@ public function getSuppressNavigation() /** * Sets suppress_navigation + * * @param string $suppress_navigation Specifies whether the window is displayed with or without dressing. + * * @return $this */ public function setSuppressNavigation($suppress_navigation) @@ -193,7 +259,9 @@ public function setSuppressNavigation($suppress_navigation) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Country.php b/src/Model/Country.php index f4f7d245..d3afe6d3 100644 --- a/src/Model/Country.php +++ b/src/Model/Country.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Country Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Country implements ArrayAccess +class Country implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'country'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class Country implements ArrayAccess 'province_validated' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'iso_code' => null, + 'name' => null, + 'provinces' => null, + 'province_validated' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'province_validated' => 'provinceValidated' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'province_validated' => 'setProvinceValidated' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'province_validated' => 'getProvinceValidated' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets iso_code + * * @return string */ public function getIsoCode() @@ -171,7 +234,9 @@ public function getIsoCode() /** * Sets iso_code + * * @param string $iso_code + * * @return $this */ public function setIsoCode($iso_code) @@ -183,6 +248,7 @@ public function setIsoCode($iso_code) /** * Gets name + * * @return string */ public function getName() @@ -192,7 +258,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -204,6 +272,7 @@ public function setName($name) /** * Gets provinces + * * @return \DocuSign\eSign\Model\Province[] */ public function getProvinces() @@ -213,7 +282,9 @@ public function getProvinces() /** * Sets provinces + * * @param \DocuSign\eSign\Model\Province[] $provinces + * * @return $this */ public function setProvinces($provinces) @@ -225,6 +296,7 @@ public function setProvinces($provinces) /** * Gets province_validated + * * @return string */ public function getProvinceValidated() @@ -234,7 +306,9 @@ public function getProvinceValidated() /** * Sets province_validated + * * @param string $province_validated + * * @return $this */ public function setProvinceValidated($province_validated) @@ -245,7 +319,9 @@ public function setProvinceValidated($province_validated) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CreditCardInformation.php b/src/Model/CreditCardInformation.php index 663b7742..10d0f31d 100644 --- a/src/Model/CreditCardInformation.php +++ b/src/Model/CreditCardInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CreditCardInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CreditCardInformation implements ArrayAccess +class CreditCardInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'creditCardInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class CreditCardInformation implements ArrayAccess 'name_on_card' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address' => null, + 'card_number' => null, + 'card_type' => null, + 'cv_number' => null, + 'expiration_month' => null, + 'expiration_year' => null, + 'name_on_card' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'name_on_card' => 'nameOnCard' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'name_on_card' => 'setNameOnCard' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'name_on_card' => 'getNameOnCard' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address + * * @return \DocuSign\eSign\Model\AddressInformation */ public function getAddress() @@ -186,7 +252,9 @@ public function getAddress() /** * Sets address - * @param \DocuSign\eSign\Model\AddressInformation $address + * + * @param \DocuSign\eSign\Model\AddressInformation $address address + * * @return $this */ public function setAddress($address) @@ -198,6 +266,7 @@ public function setAddress($address) /** * Gets card_number + * * @return string */ public function getCardNumber() @@ -207,7 +276,9 @@ public function getCardNumber() /** * Sets card_number + * * @param string $card_number The number on the credit card. + * * @return $this */ public function setCardNumber($card_number) @@ -219,6 +290,7 @@ public function setCardNumber($card_number) /** * Gets card_type + * * @return string */ public function getCardType() @@ -228,7 +300,9 @@ public function getCardType() /** * Sets card_type + * * @param string $card_type The credit card type. Valid values are: visa, mastercard, or amex. + * * @return $this */ public function setCardType($card_type) @@ -240,6 +314,7 @@ public function setCardType($card_type) /** * Gets cv_number + * * @return string */ public function getCvNumber() @@ -249,7 +324,9 @@ public function getCvNumber() /** * Sets cv_number + * * @param string $cv_number + * * @return $this */ public function setCvNumber($cv_number) @@ -261,6 +338,7 @@ public function setCvNumber($cv_number) /** * Gets expiration_month + * * @return string */ public function getExpirationMonth() @@ -270,7 +348,9 @@ public function getExpirationMonth() /** * Sets expiration_month + * * @param string $expiration_month The month that the credit card expires (1-12). + * * @return $this */ public function setExpirationMonth($expiration_month) @@ -282,6 +362,7 @@ public function setExpirationMonth($expiration_month) /** * Gets expiration_year + * * @return string */ public function getExpirationYear() @@ -291,7 +372,9 @@ public function getExpirationYear() /** * Sets expiration_year + * * @param string $expiration_year The year 4 digit year in which the credit card expires. + * * @return $this */ public function setExpirationYear($expiration_year) @@ -303,6 +386,7 @@ public function setExpirationYear($expiration_year) /** * Gets name_on_card + * * @return string */ public function getNameOnCard() @@ -312,7 +396,9 @@ public function getNameOnCard() /** * Sets name_on_card + * * @param string $name_on_card The exact name printed on the credit card. + * * @return $this */ public function setNameOnCard($name_on_card) @@ -323,7 +409,9 @@ public function setNameOnCard($name_on_card) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CreditCardTypes.php b/src/Model/CreditCardTypes.php index de5d040f..7d24eac6 100644 --- a/src/Model/CreditCardTypes.php +++ b/src/Model/CreditCardTypes.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CreditCardTypes Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CreditCardTypes implements ArrayAccess +class CreditCardTypes implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'creditCardTypes'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'card_types' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'card_types' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'card_types' => 'cardTypes' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'card_types' => 'setCardTypes' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'card_types' => 'getCardTypes' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets card_types + * * @return string[] */ public function getCardTypes() @@ -156,7 +216,9 @@ public function getCardTypes() /** * Sets card_types + * * @param string[] $card_types An array containing supported credit card types. + * * @return $this */ public function setCardTypes($card_types) @@ -167,7 +229,9 @@ public function setCardTypes($card_types) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CurrencyFeatureSetPrice.php b/src/Model/CurrencyFeatureSetPrice.php index f2536d18..0ce42127 100644 --- a/src/Model/CurrencyFeatureSetPrice.php +++ b/src/Model/CurrencyFeatureSetPrice.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CurrencyFeatureSetPrice Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CurrencyFeatureSetPrice implements ArrayAccess +class CurrencyFeatureSetPrice implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'currencyFeatureSetPrice'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class CurrencyFeatureSetPrice implements ArrayAccess 'seat_fee' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'currency_code' => null, + 'currency_symbol' => null, + 'envelope_fee' => null, + 'fixed_fee' => null, + 'seat_fee' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'seat_fee' => 'seatFee' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'seat_fee' => 'setSeatFee' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'seat_fee' => 'getSeatFee' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -176,7 +240,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code Specifies the alternate ISO currency code for the account. + * * @return $this */ public function setCurrencyCode($currency_code) @@ -188,6 +254,7 @@ public function setCurrencyCode($currency_code) /** * Gets currency_symbol + * * @return string */ public function getCurrencySymbol() @@ -197,7 +264,9 @@ public function getCurrencySymbol() /** * Sets currency_symbol + * * @param string $currency_symbol Specifies the alternate currency symbol for the account. + * * @return $this */ public function setCurrencySymbol($currency_symbol) @@ -209,6 +278,7 @@ public function setCurrencySymbol($currency_symbol) /** * Gets envelope_fee + * * @return string */ public function getEnvelopeFee() @@ -218,7 +288,9 @@ public function getEnvelopeFee() /** * Sets envelope_fee + * * @param string $envelope_fee An incremental envelope cost for plans with envelope overages (when `isEnabled` is set to **true**.) + * * @return $this */ public function setEnvelopeFee($envelope_fee) @@ -230,6 +302,7 @@ public function setEnvelopeFee($envelope_fee) /** * Gets fixed_fee + * * @return string */ public function getFixedFee() @@ -239,7 +312,9 @@ public function getFixedFee() /** * Sets fixed_fee + * * @param string $fixed_fee Specifies a one-time fee associated with the plan (when `isEnabled` is set to **true**.) + * * @return $this */ public function setFixedFee($fixed_fee) @@ -251,6 +326,7 @@ public function setFixedFee($fixed_fee) /** * Gets seat_fee + * * @return string */ public function getSeatFee() @@ -260,7 +336,9 @@ public function getSeatFee() /** * Sets seat_fee + * * @param string $seat_fee Specifies an incremental seat cost for seat-based plans (when `isEnabled` is set to **true**.) + * * @return $this */ public function setSeatFee($seat_fee) @@ -271,7 +349,9 @@ public function setSeatFee($seat_fee) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CurrencyPlanPrice.php b/src/Model/CurrencyPlanPrice.php index 2d90e62e..65cb9ade 100644 --- a/src/Model/CurrencyPlanPrice.php +++ b/src/Model/CurrencyPlanPrice.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CurrencyPlanPrice Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CurrencyPlanPrice implements ArrayAccess +class CurrencyPlanPrice implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'currencyPlanPrice'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class CurrencyPlanPrice implements ArrayAccess 'support_plan_fee' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'currency_code' => null, + 'currency_symbol' => null, + 'per_seat_price' => null, + 'supported_card_types' => null, + 'support_incident_fee' => null, + 'support_plan_fee' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'support_plan_fee' => 'supportPlanFee' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'support_plan_fee' => 'setSupportPlanFee' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'support_plan_fee' => 'getSupportPlanFee' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -181,7 +246,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code Specifies the ISO currency code for the account. + * * @return $this */ public function setCurrencyCode($currency_code) @@ -193,6 +260,7 @@ public function setCurrencyCode($currency_code) /** * Gets currency_symbol + * * @return string */ public function getCurrencySymbol() @@ -202,7 +270,9 @@ public function getCurrencySymbol() /** * Sets currency_symbol + * * @param string $currency_symbol Specifies the currency symbol for the account. + * * @return $this */ public function setCurrencySymbol($currency_symbol) @@ -214,6 +284,7 @@ public function setCurrencySymbol($currency_symbol) /** * Gets per_seat_price + * * @return string */ public function getPerSeatPrice() @@ -223,7 +294,9 @@ public function getPerSeatPrice() /** * Sets per_seat_price + * * @param string $per_seat_price + * * @return $this */ public function setPerSeatPrice($per_seat_price) @@ -235,6 +308,7 @@ public function setPerSeatPrice($per_seat_price) /** * Gets supported_card_types + * * @return \DocuSign\eSign\Model\CreditCardTypes */ public function getSupportedCardTypes() @@ -244,7 +318,9 @@ public function getSupportedCardTypes() /** * Sets supported_card_types - * @param \DocuSign\eSign\Model\CreditCardTypes $supported_card_types + * + * @param \DocuSign\eSign\Model\CreditCardTypes $supported_card_types supported_card_types + * * @return $this */ public function setSupportedCardTypes($supported_card_types) @@ -256,6 +332,7 @@ public function setSupportedCardTypes($supported_card_types) /** * Gets support_incident_fee + * * @return string */ public function getSupportIncidentFee() @@ -265,7 +342,9 @@ public function getSupportIncidentFee() /** * Sets support_incident_fee + * * @param string $support_incident_fee The support incident fee charged for each support incident. + * * @return $this */ public function setSupportIncidentFee($support_incident_fee) @@ -277,6 +356,7 @@ public function setSupportIncidentFee($support_incident_fee) /** * Gets support_plan_fee + * * @return string */ public function getSupportPlanFee() @@ -286,7 +366,9 @@ public function getSupportPlanFee() /** * Sets support_plan_fee + * * @param string $support_plan_fee The support plan fee charged for this plan. + * * @return $this */ public function setSupportPlanFee($support_plan_fee) @@ -297,7 +379,9 @@ public function setSupportPlanFee($support_plan_fee) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CustomField.php b/src/Model/CustomField.php index 08e0512b..f4bce233 100644 --- a/src/Model/CustomField.php +++ b/src/Model/CustomField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CustomField Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CustomField implements ArrayAccess +class CustomField implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'customField'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class CustomField implements ArrayAccess 'value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'custom_field_type' => null, + 'error_details' => null, + 'field_id' => null, + 'list_items' => null, + 'name' => null, + 'required' => null, + 'show' => null, + 'value' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'value' => 'value' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'value' => 'setValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'value' => 'getValue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets custom_field_type + * * @return string */ public function getCustomFieldType() @@ -191,7 +258,9 @@ public function getCustomFieldType() /** * Sets custom_field_type + * * @param string $custom_field_type + * * @return $this */ public function setCustomFieldType($custom_field_type) @@ -203,6 +272,7 @@ public function setCustomFieldType($custom_field_type) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -212,7 +282,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -224,6 +296,7 @@ public function setErrorDetails($error_details) /** * Gets field_id + * * @return string */ public function getFieldId() @@ -233,7 +306,9 @@ public function getFieldId() /** * Sets field_id + * * @param string $field_id + * * @return $this */ public function setFieldId($field_id) @@ -245,6 +320,7 @@ public function setFieldId($field_id) /** * Gets list_items + * * @return string[] */ public function getListItems() @@ -254,7 +330,9 @@ public function getListItems() /** * Sets list_items + * * @param string[] $list_items + * * @return $this */ public function setListItems($list_items) @@ -266,6 +344,7 @@ public function setListItems($list_items) /** * Gets name + * * @return string */ public function getName() @@ -275,7 +354,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -287,6 +368,7 @@ public function setName($name) /** * Gets required + * * @return string */ public function getRequired() @@ -296,7 +378,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -308,6 +392,7 @@ public function setRequired($required) /** * Gets show + * * @return string */ public function getShow() @@ -317,7 +402,9 @@ public function getShow() /** * Sets show + * * @param string $show + * * @return $this */ public function setShow($show) @@ -329,6 +416,7 @@ public function setShow($show) /** * Gets value + * * @return string */ public function getValue() @@ -338,7 +426,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -349,7 +439,9 @@ public function setValue($value) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CustomFields.php b/src/Model/CustomFields.php index 852c96d7..a65a2295 100644 --- a/src/Model/CustomFields.php +++ b/src/Model/CustomFields.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CustomFields Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CustomFields implements ArrayAccess +class CustomFields implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'customFields'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,40 @@ class CustomFields implements ArrayAccess 'text_custom_fields' => '\DocuSign\eSign\Model\TextCustomField[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'list_custom_fields' => null, + 'text_custom_fields' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -73,9 +103,9 @@ public static function swaggerTypes() 'text_custom_fields' => 'textCustomFields' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -83,9 +113,9 @@ public static function swaggerTypes() 'text_custom_fields' => 'setTextCustomFields' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -93,34 +123,63 @@ public static function swaggerTypes() 'text_custom_fields' => 'getTextCustomFields' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -129,30 +188,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets list_custom_fields + * * @return \DocuSign\eSign\Model\ListCustomField[] */ public function getListCustomFields() @@ -162,7 +223,9 @@ public function getListCustomFields() /** * Sets list_custom_fields + * * @param \DocuSign\eSign\Model\ListCustomField[] $list_custom_fields An array of list custom fields. + * * @return $this */ public function setListCustomFields($list_custom_fields) @@ -174,6 +237,7 @@ public function setListCustomFields($list_custom_fields) /** * Gets text_custom_fields + * * @return \DocuSign\eSign\Model\TextCustomField[] */ public function getTextCustomFields() @@ -183,7 +247,9 @@ public function getTextCustomFields() /** * Sets text_custom_fields + * * @param \DocuSign\eSign\Model\TextCustomField[] $text_custom_fields An array of text custom fields. + * * @return $this */ public function setTextCustomFields($text_custom_fields) @@ -194,7 +260,9 @@ public function setTextCustomFields($text_custom_fields) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -204,7 +272,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -214,8 +284,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -229,7 +301,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -239,16 +313,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CustomFieldsEnvelope.php b/src/Model/CustomFieldsEnvelope.php index 7db3ed82..5be5c604 100644 --- a/src/Model/CustomFieldsEnvelope.php +++ b/src/Model/CustomFieldsEnvelope.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CustomFieldsEnvelope Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CustomFieldsEnvelope implements ArrayAccess +class CustomFieldsEnvelope implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'customFieldsEnvelope'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class CustomFieldsEnvelope implements ArrayAccess 'text_custom_fields' => '\DocuSign\eSign\Model\TextCustomField[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'list_custom_fields' => null, + 'text_custom_fields' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'text_custom_fields' => 'textCustomFields' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'text_custom_fields' => 'setTextCustomFields' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'text_custom_fields' => 'getTextCustomFields' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets list_custom_fields + * * @return \DocuSign\eSign\Model\ListCustomField[] */ public function getListCustomFields() @@ -161,7 +222,9 @@ public function getListCustomFields() /** * Sets list_custom_fields + * * @param \DocuSign\eSign\Model\ListCustomField[] $list_custom_fields An array of list custom fields. + * * @return $this */ public function setListCustomFields($list_custom_fields) @@ -173,6 +236,7 @@ public function setListCustomFields($list_custom_fields) /** * Gets text_custom_fields + * * @return \DocuSign\eSign\Model\TextCustomField[] */ public function getTextCustomFields() @@ -182,7 +246,9 @@ public function getTextCustomFields() /** * Sets text_custom_fields + * * @param \DocuSign\eSign\Model\TextCustomField[] $text_custom_fields An array of text custom fields. + * * @return $this */ public function setTextCustomFields($text_custom_fields) @@ -193,7 +259,9 @@ public function setTextCustomFields($text_custom_fields) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/CustomSettingsInformation.php b/src/Model/CustomSettingsInformation.php index 59c62485..bd233fd9 100644 --- a/src/Model/CustomSettingsInformation.php +++ b/src/Model/CustomSettingsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CustomSettingsInformation Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CustomSettingsInformation implements ArrayAccess +class CustomSettingsInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'customSettingsInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'custom_settings' => '\DocuSign\eSign\Model\NameValue[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'custom_settings' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'custom_settings' => 'customSettings' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'custom_settings' => 'setCustomSettings' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'custom_settings' => 'getCustomSettings' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets custom_settings + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getCustomSettings() @@ -156,7 +216,9 @@ public function getCustomSettings() /** * Sets custom_settings + * * @param \DocuSign\eSign\Model\NameValue[] $custom_settings + * * @return $this */ public function setCustomSettings($custom_settings) @@ -167,7 +229,9 @@ public function setCustomSettings($custom_settings) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Date.php b/src/Model/Date.php index 4d9658f7..e1300160 100644 --- a/src/Model/Date.php +++ b/src/Model/Date.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Date Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Date implements ArrayAccess +class Date implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'date'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -167,13 +170,149 @@ class Date implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conceal_value_on_document' => null, + 'conceal_value_on_document_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'disable_auto_size' => null, + 'disable_auto_size_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'max_length' => null, + 'max_length_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'original_value' => null, + 'original_value_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'require_all' => null, + 'require_all_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'sender_required' => null, + 'sender_required_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'validation_message' => null, + 'validation_message_metadata' => null, + 'validation_pattern' => null, + 'validation_pattern_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -290,9 +429,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -409,9 +548,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -528,34 +667,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -673,30 +841,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -706,7 +876,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -718,6 +890,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -727,7 +900,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -739,6 +914,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -748,7 +924,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -760,6 +938,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -769,7 +948,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -781,6 +962,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -790,7 +972,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -802,6 +986,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -811,7 +996,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -823,6 +1010,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -832,7 +1020,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -844,6 +1034,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -853,7 +1044,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -865,6 +1058,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -874,7 +1068,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -886,6 +1082,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -895,7 +1092,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -907,6 +1106,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -916,7 +1116,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -928,6 +1130,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -937,7 +1140,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -949,6 +1154,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -958,7 +1164,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -970,6 +1178,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -979,7 +1188,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -991,6 +1202,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -1000,7 +1212,9 @@ public function getAnchorUnits() /** * 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) @@ -1012,6 +1226,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -1021,7 +1236,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -1033,6 +1250,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -1042,7 +1260,9 @@ public function getAnchorXOffset() /** * 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) @@ -1054,6 +1274,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1063,7 +1284,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1075,6 +1298,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1084,7 +1308,9 @@ public function getAnchorYOffset() /** * 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) @@ -1096,6 +1322,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1105,7 +1332,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1117,6 +1346,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1126,7 +1356,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1138,6 +1370,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1147,7 +1380,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1159,6 +1394,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -1168,7 +1404,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -1180,6 +1418,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conceal_value_on_document_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConcealValueOnDocumentMetadata() @@ -1189,7 +1428,9 @@ public function getConcealValueOnDocumentMetadata() /** * Sets conceal_value_on_document_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata conceal_value_on_document_metadata + * * @return $this */ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_metadata) @@ -1201,6 +1442,7 @@ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_met /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1210,7 +1452,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1222,6 +1466,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1231,7 +1476,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1243,6 +1490,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1252,7 +1500,9 @@ public function getConditionalParentValue() /** * 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) @@ -1264,6 +1514,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1273,7 +1524,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1285,6 +1538,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1294,7 +1548,9 @@ public function getCustomTabId() /** * 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) @@ -1306,6 +1562,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1315,7 +1572,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1327,6 +1586,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -1336,7 +1596,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -1348,6 +1610,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets disable_auto_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisableAutoSizeMetadata() @@ -1357,7 +1620,9 @@ public function getDisableAutoSizeMetadata() /** * Sets disable_auto_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata disable_auto_size_metadata + * * @return $this */ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) @@ -1369,6 +1634,7 @@ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1378,7 +1644,9 @@ public function getDocumentId() /** * 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) @@ -1390,6 +1658,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1399,7 +1668,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1411,6 +1682,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1420,7 +1692,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1432,6 +1706,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1441,7 +1716,9 @@ public function getFont() /** * 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) @@ -1453,6 +1730,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1462,7 +1740,9 @@ public function getFontColor() /** * 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) @@ -1474,6 +1754,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1483,7 +1764,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1495,6 +1778,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1504,7 +1788,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1516,6 +1802,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1525,7 +1812,9 @@ public function getFontSize() /** * 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) @@ -1537,6 +1826,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1546,7 +1836,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1558,6 +1850,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1567,7 +1860,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1579,6 +1874,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1588,7 +1884,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1600,6 +1898,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1609,7 +1908,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1621,6 +1922,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1630,7 +1932,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1642,6 +1946,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1651,7 +1956,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1663,6 +1970,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1672,7 +1980,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1684,6 +1994,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1693,7 +2004,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1705,6 +2018,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1714,7 +2028,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1726,6 +2042,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1735,7 +2052,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1747,6 +2066,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1756,7 +2076,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1768,6 +2090,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1777,7 +2100,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1789,6 +2114,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1798,7 +2124,9 @@ public function getLocked() /** * 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) @@ -1810,6 +2138,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1819,7 +2148,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1831,6 +2162,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets max_length + * * @return string */ public function getMaxLength() @@ -1840,7 +2172,9 @@ public function getMaxLength() /** * Sets max_length + * * @param string $max_length An optional value that describes the maximum length of the property when the property is a string. + * * @return $this */ public function setMaxLength($max_length) @@ -1852,6 +2186,7 @@ public function setMaxLength($max_length) /** * Gets max_length_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaxLengthMetadata() @@ -1861,7 +2196,9 @@ public function getMaxLengthMetadata() /** * Sets max_length_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata max_length_metadata + * * @return $this */ public function setMaxLengthMetadata($max_length_metadata) @@ -1873,6 +2210,7 @@ public function setMaxLengthMetadata($max_length_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1882,7 +2220,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1894,6 +2234,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1903,7 +2244,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1915,6 +2258,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1924,7 +2268,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1936,6 +2282,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1945,7 +2292,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1957,6 +2306,7 @@ public function setNameMetadata($name_metadata) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -1966,7 +2316,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -1978,6 +2330,7 @@ public function setOriginalValue($original_value) /** * Gets original_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOriginalValueMetadata() @@ -1987,7 +2340,9 @@ public function getOriginalValueMetadata() /** * Sets original_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata original_value_metadata + * * @return $this */ public function setOriginalValueMetadata($original_value_metadata) @@ -1999,6 +2354,7 @@ public function setOriginalValueMetadata($original_value_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -2008,7 +2364,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -2020,6 +2378,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -2029,7 +2388,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -2041,6 +2402,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -2050,7 +2412,9 @@ public function getRecipientId() /** * 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) @@ -2062,6 +2426,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -2071,7 +2436,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -2083,6 +2450,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -2092,7 +2460,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -2104,6 +2474,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -2113,7 +2484,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -2125,6 +2498,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -2134,7 +2508,9 @@ public function getRequireAll() /** * 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) @@ -2146,6 +2522,7 @@ public function setRequireAll($require_all) /** * Gets require_all_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireAllMetadata() @@ -2155,7 +2532,9 @@ public function getRequireAllMetadata() /** * Sets require_all_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata require_all_metadata + * * @return $this */ public function setRequireAllMetadata($require_all_metadata) @@ -2167,6 +2546,7 @@ public function setRequireAllMetadata($require_all_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -2176,7 +2556,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -2188,6 +2570,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -2197,7 +2580,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2209,6 +2594,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -2218,7 +2604,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -2230,6 +2618,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -2239,7 +2628,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -2251,6 +2642,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -2260,7 +2652,9 @@ public function getSenderRequired() /** * 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. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + * * @return $this */ public function setSenderRequired($sender_required) @@ -2272,6 +2666,7 @@ public function setSenderRequired($sender_required) /** * Gets sender_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderRequiredMetadata() @@ -2281,7 +2676,9 @@ public function getSenderRequiredMetadata() /** * Sets sender_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata sender_required_metadata + * * @return $this */ public function setSenderRequiredMetadata($sender_required_metadata) @@ -2293,6 +2690,7 @@ public function setSenderRequiredMetadata($sender_required_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -2302,7 +2700,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -2314,6 +2714,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -2323,7 +2724,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -2335,6 +2738,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2344,7 +2748,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2356,6 +2762,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2365,7 +2772,9 @@ public function getStatus() /** * 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) @@ -2377,6 +2786,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2386,7 +2796,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2398,6 +2810,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2407,7 +2820,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2419,6 +2834,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2428,7 +2844,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2440,6 +2858,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2449,7 +2868,9 @@ public function getTabId() /** * 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) @@ -2461,6 +2882,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2470,7 +2892,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2482,6 +2906,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2491,7 +2916,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2503,6 +2930,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2512,7 +2940,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2524,6 +2954,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2533,7 +2964,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2545,6 +2978,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2554,7 +2988,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2566,6 +3002,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2575,7 +3012,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2587,6 +3026,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2596,7 +3036,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2608,6 +3050,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2617,7 +3060,9 @@ public function getTemplateLocked() /** * 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) @@ -2629,6 +3074,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2638,7 +3084,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2650,6 +3098,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2659,7 +3108,9 @@ public function getTemplateRequired() /** * 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) @@ -2671,6 +3122,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2680,7 +3132,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2692,6 +3146,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2701,7 +3156,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2713,6 +3170,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2722,7 +3180,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2734,6 +3194,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2743,7 +3204,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2755,6 +3218,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2764,7 +3228,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2776,6 +3242,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -2785,7 +3252,9 @@ public function getValidationMessage() /** * Sets validation_message + * * @param string $validation_message The message displayed if the custom tab fails input validation (either custom of embedded). + * * @return $this */ public function setValidationMessage($validation_message) @@ -2797,6 +3266,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_message_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationMessageMetadata() @@ -2806,7 +3276,9 @@ public function getValidationMessageMetadata() /** * Sets validation_message_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata validation_message_metadata + * * @return $this */ public function setValidationMessageMetadata($validation_message_metadata) @@ -2818,6 +3290,7 @@ public function setValidationMessageMetadata($validation_message_metadata) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -2827,7 +3300,9 @@ public function getValidationPattern() /** * Sets validation_pattern + * * @param string $validation_pattern A regular expression used to validate input for the tab. + * * @return $this */ public function setValidationPattern($validation_pattern) @@ -2839,6 +3314,7 @@ public function setValidationPattern($validation_pattern) /** * Gets validation_pattern_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationPatternMetadata() @@ -2848,7 +3324,9 @@ public function getValidationPatternMetadata() /** * Sets validation_pattern_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata validation_pattern_metadata + * * @return $this */ public function setValidationPatternMetadata($validation_pattern_metadata) @@ -2860,6 +3338,7 @@ public function setValidationPatternMetadata($validation_pattern_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2869,7 +3348,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2881,6 +3362,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2890,7 +3372,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2902,6 +3386,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2911,7 +3396,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2923,6 +3410,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2932,7 +3420,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2944,6 +3434,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2953,7 +3444,9 @@ public function getXPosition() /** * 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) @@ -2965,6 +3458,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2974,7 +3468,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2986,6 +3482,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2995,7 +3492,9 @@ public function getYPosition() /** * 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) @@ -3007,6 +3506,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -3016,7 +3516,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -3027,7 +3529,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -3037,7 +3541,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -3047,8 +3553,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -3062,7 +3570,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -3072,16 +3582,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DateSigned.php b/src/Model/DateSigned.php index 95e11171..8e5aa716 100644 --- a/src/Model/DateSigned.php +++ b/src/Model/DateSigned.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DateSigned Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DateSigned implements ArrayAccess +class DateSigned implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'dateSigned'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -143,13 +146,125 @@ class DateSigned implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -242,9 +357,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -337,9 +452,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -432,34 +547,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -553,30 +697,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -586,7 +732,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -598,6 +746,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -607,7 +756,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -619,6 +770,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -628,7 +780,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -640,6 +794,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -649,7 +804,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -661,6 +818,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -670,7 +828,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -682,6 +842,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -691,7 +852,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -703,6 +866,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -712,7 +876,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -724,6 +890,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -733,7 +900,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -745,6 +914,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -754,7 +924,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -766,6 +938,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -775,7 +948,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -787,6 +962,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -796,7 +972,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -808,6 +986,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -817,7 +996,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -829,6 +1010,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -838,7 +1020,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -850,6 +1034,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -859,7 +1044,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -871,6 +1058,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -880,7 +1068,9 @@ public function getAnchorUnits() /** * 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) @@ -892,6 +1082,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -901,7 +1092,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -913,6 +1106,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -922,7 +1116,9 @@ public function getAnchorXOffset() /** * 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) @@ -934,6 +1130,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -943,7 +1140,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -955,6 +1154,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -964,7 +1164,9 @@ public function getAnchorYOffset() /** * 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) @@ -976,6 +1178,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -985,7 +1188,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -997,6 +1202,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1006,7 +1212,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1018,6 +1226,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1027,7 +1236,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1039,6 +1250,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1048,7 +1260,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1060,6 +1274,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1069,7 +1284,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1081,6 +1298,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1090,7 +1308,9 @@ public function getConditionalParentValue() /** * 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) @@ -1102,6 +1322,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1111,7 +1332,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1123,6 +1346,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1132,7 +1356,9 @@ public function getCustomTabId() /** * 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) @@ -1144,6 +1370,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1153,7 +1380,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1165,6 +1394,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1174,7 +1404,9 @@ public function getDocumentId() /** * 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) @@ -1186,6 +1418,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1195,7 +1428,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1207,6 +1442,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1216,7 +1452,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1228,6 +1466,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1237,7 +1476,9 @@ public function getFont() /** * 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) @@ -1249,6 +1490,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1258,7 +1500,9 @@ public function getFontColor() /** * 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) @@ -1270,6 +1514,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1279,7 +1524,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1291,6 +1538,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1300,7 +1548,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1312,6 +1562,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1321,7 +1572,9 @@ public function getFontSize() /** * 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) @@ -1333,6 +1586,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1342,7 +1596,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1354,6 +1610,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1363,7 +1620,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1375,6 +1634,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1384,7 +1644,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1396,6 +1658,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1405,7 +1668,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1417,6 +1682,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1426,7 +1692,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1438,6 +1706,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1447,7 +1716,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1459,6 +1730,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1468,7 +1740,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1480,6 +1754,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1489,7 +1764,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1501,6 +1778,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1510,7 +1788,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1522,6 +1802,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1531,7 +1812,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1543,6 +1826,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1552,7 +1836,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1564,6 +1850,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1573,7 +1860,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1585,6 +1874,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1594,7 +1884,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1606,6 +1898,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1615,7 +1908,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1627,6 +1922,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1636,7 +1932,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1648,6 +1946,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1657,7 +1956,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1669,6 +1970,7 @@ public function setNameMetadata($name_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1678,7 +1980,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1690,6 +1994,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1699,7 +2004,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1711,6 +2018,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1720,7 +2028,9 @@ public function getRecipientId() /** * 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) @@ -1732,6 +2042,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1741,7 +2052,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1753,6 +2066,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1762,7 +2076,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1774,6 +2090,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1783,7 +2100,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1795,6 +2114,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1804,7 +2124,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1816,6 +2138,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1825,7 +2148,9 @@ public function getStatus() /** * 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) @@ -1837,6 +2162,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1846,7 +2172,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1858,6 +2186,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1867,7 +2196,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1879,6 +2210,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1888,7 +2220,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1900,6 +2234,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1909,7 +2244,9 @@ public function getTabId() /** * 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) @@ -1921,6 +2258,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1930,7 +2268,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1942,6 +2282,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1951,7 +2292,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1963,6 +2306,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1972,7 +2316,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1984,6 +2330,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1993,7 +2340,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2005,6 +2354,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2014,7 +2364,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2026,6 +2378,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2035,7 +2388,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2047,6 +2402,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2056,7 +2412,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2068,6 +2426,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2077,7 +2436,9 @@ public function getTemplateLocked() /** * 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) @@ -2089,6 +2450,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2098,7 +2460,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2110,6 +2474,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2119,7 +2484,9 @@ public function getTemplateRequired() /** * 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) @@ -2131,6 +2498,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2140,7 +2508,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2152,6 +2522,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2161,7 +2532,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2173,6 +2546,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2182,7 +2556,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2194,6 +2570,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2203,7 +2580,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2215,6 +2594,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2224,7 +2604,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2236,6 +2618,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2245,7 +2628,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2257,6 +2642,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2266,7 +2652,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2278,6 +2666,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2287,7 +2676,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2299,6 +2690,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2308,7 +2700,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2320,6 +2714,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2329,7 +2724,9 @@ public function getXPosition() /** * 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) @@ -2341,6 +2738,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2350,7 +2748,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2362,6 +2762,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2371,7 +2772,9 @@ public function getYPosition() /** * 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) @@ -2383,6 +2786,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2392,7 +2796,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2403,7 +2809,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2413,7 +2821,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2423,8 +2833,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2438,7 +2850,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2448,16 +2862,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DateStampProperties.php b/src/Model/DateStampProperties.php index 99f4b913..38b4e1e7 100644 --- a/src/Model/DateStampProperties.php +++ b/src/Model/DateStampProperties.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DateStampProperties Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DateStampProperties implements ArrayAccess +class DateStampProperties implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'dateStampProperties'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class DateStampProperties implements ArrayAccess 'date_area_y' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'date_area_height' => null, + 'date_area_width' => null, + 'date_area_x' => null, + 'date_area_y' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'date_area_y' => 'dateAreaY' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'date_area_y' => 'setDateAreaY' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'date_area_y' => 'getDateAreaY' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets date_area_height + * * @return string */ public function getDateAreaHeight() @@ -171,7 +234,9 @@ public function getDateAreaHeight() /** * Sets date_area_height + * * @param string $date_area_height + * * @return $this */ public function setDateAreaHeight($date_area_height) @@ -183,6 +248,7 @@ public function setDateAreaHeight($date_area_height) /** * Gets date_area_width + * * @return string */ public function getDateAreaWidth() @@ -192,7 +258,9 @@ public function getDateAreaWidth() /** * Sets date_area_width + * * @param string $date_area_width + * * @return $this */ public function setDateAreaWidth($date_area_width) @@ -204,6 +272,7 @@ public function setDateAreaWidth($date_area_width) /** * Gets date_area_x + * * @return string */ public function getDateAreaX() @@ -213,7 +282,9 @@ public function getDateAreaX() /** * Sets date_area_x + * * @param string $date_area_x + * * @return $this */ public function setDateAreaX($date_area_x) @@ -225,6 +296,7 @@ public function setDateAreaX($date_area_x) /** * Gets date_area_y + * * @return string */ public function getDateAreaY() @@ -234,7 +306,9 @@ public function getDateAreaY() /** * Sets date_area_y + * * @param string $date_area_y + * * @return $this */ public function setDateAreaY($date_area_y) @@ -245,7 +319,9 @@ public function setDateAreaY($date_area_y) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Decline.php b/src/Model/Decline.php index 1ba58e5b..ff009544 100644 --- a/src/Model/Decline.php +++ b/src/Model/Decline.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Decline Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Decline implements ArrayAccess +class Decline implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'decline'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -143,13 +146,125 @@ class Decline implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'button_text' => null, + 'button_text_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'decline_reason' => null, + 'decline_reason_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -242,9 +357,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -337,9 +452,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -432,34 +547,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -553,30 +697,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -586,7 +732,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -598,6 +746,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -607,7 +756,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -619,6 +770,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -628,7 +780,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -640,6 +794,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -649,7 +804,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -661,6 +818,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -670,7 +828,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -682,6 +842,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -691,7 +852,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -703,6 +866,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -712,7 +876,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -724,6 +890,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -733,7 +900,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -745,6 +914,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -754,7 +924,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -766,6 +938,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -775,7 +948,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -787,6 +962,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -796,7 +972,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -808,6 +986,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -817,7 +996,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -829,6 +1010,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -838,7 +1020,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -850,6 +1034,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -859,7 +1044,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -871,6 +1058,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -880,7 +1068,9 @@ public function getAnchorUnits() /** * 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) @@ -892,6 +1082,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -901,7 +1092,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -913,6 +1106,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -922,7 +1116,9 @@ public function getAnchorXOffset() /** * 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) @@ -934,6 +1130,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -943,7 +1140,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -955,6 +1154,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -964,7 +1164,9 @@ public function getAnchorYOffset() /** * 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) @@ -976,6 +1178,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -985,7 +1188,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -997,6 +1202,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1006,7 +1212,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1018,6 +1226,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1027,7 +1236,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1039,6 +1250,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets button_text + * * @return string */ public function getButtonText() @@ -1048,7 +1260,9 @@ public function getButtonText() /** * Sets button_text + * * @param string $button_text Specifies the decline text displayed in the tab. + * * @return $this */ public function setButtonText($button_text) @@ -1060,6 +1274,7 @@ public function setButtonText($button_text) /** * Gets button_text_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getButtonTextMetadata() @@ -1069,7 +1284,9 @@ public function getButtonTextMetadata() /** * Sets button_text_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $button_text_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $button_text_metadata button_text_metadata + * * @return $this */ public function setButtonTextMetadata($button_text_metadata) @@ -1081,6 +1298,7 @@ public function setButtonTextMetadata($button_text_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1090,7 +1308,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1102,6 +1322,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1111,7 +1332,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1123,6 +1346,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1132,7 +1356,9 @@ public function getConditionalParentValue() /** * 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) @@ -1144,6 +1370,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1153,7 +1380,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1165,6 +1394,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1174,7 +1404,9 @@ public function getCustomTabId() /** * 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) @@ -1186,6 +1418,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1195,7 +1428,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1207,6 +1442,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets decline_reason + * * @return string */ public function getDeclineReason() @@ -1216,7 +1452,9 @@ public function getDeclineReason() /** * Sets decline_reason + * * @param string $decline_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclineReason($decline_reason) @@ -1228,6 +1466,7 @@ public function setDeclineReason($decline_reason) /** * Gets decline_reason_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeclineReasonMetadata() @@ -1237,7 +1476,9 @@ public function getDeclineReasonMetadata() /** * Sets decline_reason_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $decline_reason_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $decline_reason_metadata decline_reason_metadata + * * @return $this */ public function setDeclineReasonMetadata($decline_reason_metadata) @@ -1249,6 +1490,7 @@ public function setDeclineReasonMetadata($decline_reason_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1258,7 +1500,9 @@ public function getDocumentId() /** * 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) @@ -1270,6 +1514,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1279,7 +1524,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1291,6 +1538,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1300,7 +1548,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1312,6 +1562,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1321,7 +1572,9 @@ public function getFont() /** * 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) @@ -1333,6 +1586,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1342,7 +1596,9 @@ public function getFontColor() /** * 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) @@ -1354,6 +1610,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1363,7 +1620,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1375,6 +1634,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1384,7 +1644,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1396,6 +1658,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1405,7 +1668,9 @@ public function getFontSize() /** * 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) @@ -1417,6 +1682,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1426,7 +1692,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1438,6 +1706,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1447,7 +1716,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1459,6 +1730,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1468,7 +1740,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1480,6 +1754,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1489,7 +1764,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1501,6 +1778,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1510,7 +1788,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1522,6 +1802,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1531,7 +1812,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1543,6 +1826,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1552,7 +1836,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1564,6 +1850,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1573,7 +1860,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1585,6 +1874,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1594,7 +1884,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1606,6 +1898,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1615,7 +1908,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1627,6 +1922,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1636,7 +1932,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1648,6 +1946,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1657,7 +1956,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1669,6 +1970,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1678,7 +1980,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1690,6 +1994,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1699,7 +2004,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1711,6 +2018,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1720,7 +2028,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1732,6 +2042,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1741,7 +2052,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1753,6 +2066,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1762,7 +2076,9 @@ public function getRecipientId() /** * 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) @@ -1774,6 +2090,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1783,7 +2100,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1795,6 +2114,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1804,7 +2124,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1816,6 +2138,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1825,7 +2148,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1837,6 +2162,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1846,7 +2172,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1858,6 +2186,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1867,7 +2196,9 @@ public function getStatus() /** * 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) @@ -1879,6 +2210,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1888,7 +2220,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1900,6 +2234,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1909,7 +2244,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1921,6 +2258,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1930,7 +2268,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1942,6 +2282,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1951,7 +2292,9 @@ public function getTabId() /** * 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) @@ -1963,6 +2306,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1972,7 +2316,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1984,6 +2330,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1993,7 +2340,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2005,6 +2354,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2014,7 +2364,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2026,6 +2378,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2035,7 +2388,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2047,6 +2402,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2056,7 +2412,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2068,6 +2426,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2077,7 +2436,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2089,6 +2450,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2098,7 +2460,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2110,6 +2474,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2119,7 +2484,9 @@ public function getTemplateLocked() /** * 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) @@ -2131,6 +2498,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2140,7 +2508,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2152,6 +2522,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2161,7 +2532,9 @@ public function getTemplateRequired() /** * 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) @@ -2173,6 +2546,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2182,7 +2556,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2194,6 +2570,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2203,7 +2580,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2215,6 +2594,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2224,7 +2604,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2236,6 +2618,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2245,7 +2628,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2257,6 +2642,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2266,7 +2652,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2278,6 +2666,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2287,7 +2676,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2299,6 +2690,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2308,7 +2700,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2320,6 +2714,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2329,7 +2724,9 @@ public function getXPosition() /** * 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) @@ -2341,6 +2738,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2350,7 +2748,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2362,6 +2762,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2371,7 +2772,9 @@ public function getYPosition() /** * 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) @@ -2383,6 +2786,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2392,7 +2796,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2403,7 +2809,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2413,7 +2821,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2423,8 +2833,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2438,7 +2850,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2448,16 +2862,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DiagnosticsSettingsInformation.php b/src/Model/DiagnosticsSettingsInformation.php index 0aa13575..88d15e98 100644 --- a/src/Model/DiagnosticsSettingsInformation.php +++ b/src/Model/DiagnosticsSettingsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DiagnosticsSettingsInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DiagnosticsSettingsInformation implements ArrayAccess +class DiagnosticsSettingsInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'diagnosticsSettingsInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class DiagnosticsSettingsInformation implements ArrayAccess 'api_request_log_remaining_entries' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'api_request_logging' => null, + 'api_request_log_max_entries' => null, + 'api_request_log_remaining_entries' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'api_request_log_remaining_entries' => 'apiRequestLogRemainingEntries' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'api_request_log_remaining_entries' => 'setApiRequestLogRemainingEntries' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'api_request_log_remaining_entries' => 'getApiRequestLogRemainingEntries' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets api_request_logging + * * @return string */ public function getApiRequestLogging() @@ -166,7 +228,9 @@ public function getApiRequestLogging() /** * Sets api_request_logging + * * @param string $api_request_logging When set to **true**, enables API request logging for the user. + * * @return $this */ public function setApiRequestLogging($api_request_logging) @@ -178,6 +242,7 @@ public function setApiRequestLogging($api_request_logging) /** * Gets api_request_log_max_entries + * * @return string */ public function getApiRequestLogMaxEntries() @@ -187,7 +252,9 @@ public function getApiRequestLogMaxEntries() /** * Sets api_request_log_max_entries + * * @param string $api_request_log_max_entries Specifies the maximum number of API requests to log. + * * @return $this */ public function setApiRequestLogMaxEntries($api_request_log_max_entries) @@ -199,6 +266,7 @@ public function setApiRequestLogMaxEntries($api_request_log_max_entries) /** * Gets api_request_log_remaining_entries + * * @return string */ public function getApiRequestLogRemainingEntries() @@ -208,7 +276,9 @@ public function getApiRequestLogRemainingEntries() /** * Sets api_request_log_remaining_entries + * * @param string $api_request_log_remaining_entries Indicates the remaining number of API requests that can be logged. + * * @return $this */ public function setApiRequestLogRemainingEntries($api_request_log_remaining_entries) @@ -219,7 +289,9 @@ public function setApiRequestLogRemainingEntries($api_request_log_remaining_entr } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DirectDebitProcessorInformation.php b/src/Model/DirectDebitProcessorInformation.php index be346a77..bd2360c5 100644 --- a/src/Model/DirectDebitProcessorInformation.php +++ b/src/Model/DirectDebitProcessorInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DirectDebitProcessorInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DirectDebitProcessorInformation implements ArrayAccess +class DirectDebitProcessorInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'directDebitProcessorInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -68,13 +71,50 @@ class DirectDebitProcessorInformation implements ArrayAccess 'last_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bank_branch_code' => null, + 'bank_check_digit' => null, + 'bank_code' => null, + 'bank_name' => null, + 'bank_transfer_account_name' => null, + 'bank_transfer_account_number' => null, + 'bank_transfer_type' => null, + 'country' => null, + 'email' => null, + 'first_name' => null, + 'i_ban' => null, + 'last_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -92,9 +132,9 @@ public static function swaggerTypes() 'last_name' => 'lastName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,9 +152,9 @@ public static function swaggerTypes() 'last_name' => 'setLastName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -132,34 +172,63 @@ public static function swaggerTypes() 'last_name' => 'getLastName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -178,30 +247,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bank_branch_code + * * @return string */ public function getBankBranchCode() @@ -211,7 +282,9 @@ public function getBankBranchCode() /** * Sets bank_branch_code + * * @param string $bank_branch_code + * * @return $this */ public function setBankBranchCode($bank_branch_code) @@ -223,6 +296,7 @@ public function setBankBranchCode($bank_branch_code) /** * Gets bank_check_digit + * * @return string */ public function getBankCheckDigit() @@ -232,7 +306,9 @@ public function getBankCheckDigit() /** * Sets bank_check_digit + * * @param string $bank_check_digit + * * @return $this */ public function setBankCheckDigit($bank_check_digit) @@ -244,6 +320,7 @@ public function setBankCheckDigit($bank_check_digit) /** * Gets bank_code + * * @return string */ public function getBankCode() @@ -253,7 +330,9 @@ public function getBankCode() /** * Sets bank_code + * * @param string $bank_code + * * @return $this */ public function setBankCode($bank_code) @@ -265,6 +344,7 @@ public function setBankCode($bank_code) /** * Gets bank_name + * * @return string */ public function getBankName() @@ -274,7 +354,9 @@ public function getBankName() /** * Sets bank_name + * * @param string $bank_name + * * @return $this */ public function setBankName($bank_name) @@ -286,6 +368,7 @@ public function setBankName($bank_name) /** * Gets bank_transfer_account_name + * * @return string */ public function getBankTransferAccountName() @@ -295,7 +378,9 @@ public function getBankTransferAccountName() /** * Sets bank_transfer_account_name + * * @param string $bank_transfer_account_name + * * @return $this */ public function setBankTransferAccountName($bank_transfer_account_name) @@ -307,6 +392,7 @@ public function setBankTransferAccountName($bank_transfer_account_name) /** * Gets bank_transfer_account_number + * * @return string */ public function getBankTransferAccountNumber() @@ -316,7 +402,9 @@ public function getBankTransferAccountNumber() /** * Sets bank_transfer_account_number + * * @param string $bank_transfer_account_number + * * @return $this */ public function setBankTransferAccountNumber($bank_transfer_account_number) @@ -328,6 +416,7 @@ public function setBankTransferAccountNumber($bank_transfer_account_number) /** * Gets bank_transfer_type + * * @return string */ public function getBankTransferType() @@ -337,7 +426,9 @@ public function getBankTransferType() /** * Sets bank_transfer_type + * * @param string $bank_transfer_type + * * @return $this */ public function setBankTransferType($bank_transfer_type) @@ -349,6 +440,7 @@ public function setBankTransferType($bank_transfer_type) /** * Gets country + * * @return string */ public function getCountry() @@ -358,7 +450,9 @@ public function getCountry() /** * Sets country + * * @param string $country Specifies the country associated with the address. + * * @return $this */ public function setCountry($country) @@ -370,6 +464,7 @@ public function setCountry($country) /** * Gets email + * * @return string */ public function getEmail() @@ -379,7 +474,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -391,6 +488,7 @@ public function setEmail($email) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -400,7 +498,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -412,6 +512,7 @@ public function setFirstName($first_name) /** * Gets i_ban + * * @return string */ public function getIBan() @@ -421,7 +522,9 @@ public function getIBan() /** * Sets i_ban + * * @param string $i_ban + * * @return $this */ public function setIBan($i_ban) @@ -433,6 +536,7 @@ public function setIBan($i_ban) /** * Gets last_name + * * @return string */ public function getLastName() @@ -442,7 +546,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -453,7 +559,9 @@ public function setLastName($last_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -463,7 +571,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -473,8 +583,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -488,7 +600,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -498,16 +612,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DobInformationInput.php b/src/Model/DobInformationInput.php index 9dd90602..38836cd8 100644 --- a/src/Model/DobInformationInput.php +++ b/src/Model/DobInformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DobInformationInput Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DobInformationInput implements ArrayAccess +class DobInformationInput implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'dobInformationInput'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class DobInformationInput implements ArrayAccess 'receive_in_response' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'date_of_birth' => null, + 'display_level_code' => null, + 'receive_in_response' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'receive_in_response' => 'receiveInResponse' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'receive_in_response' => 'setReceiveInResponse' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'receive_in_response' => 'getReceiveInResponse' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets date_of_birth + * * @return string */ public function getDateOfBirth() @@ -167,7 +229,9 @@ public function getDateOfBirth() /** * Sets date_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) @@ -179,6 +243,7 @@ public function setDateOfBirth($date_of_birth) /** * Gets display_level_code + * * @return string */ public function getDisplayLevelCode() @@ -188,7 +253,9 @@ public function getDisplayLevelCode() /** * Sets display_level_code + * * @param string $display_level_code Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay + * * @return $this */ public function setDisplayLevelCode($display_level_code) @@ -200,6 +267,7 @@ public function setDisplayLevelCode($display_level_code) /** * Gets receive_in_response + * * @return string */ public function getReceiveInResponse() @@ -209,7 +277,9 @@ public function getReceiveInResponse() /** * Sets receive_in_response + * * @param string $receive_in_response When set to **true**, the information needs to be returned in the response. + * * @return $this */ public function setReceiveInResponse($receive_in_response) @@ -220,7 +290,9 @@ public function setReceiveInResponse($receive_in_response) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Document.php b/src/Model/Document.php index 35ef32ec..343c806d 100644 --- a/src/Model/Document.php +++ b/src/Model/Document.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Document Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Document implements ArrayAccess +class Document implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'document'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,19 +67,12 @@ class Document implements ArrayAccess 'file_format_hint' => 'string', 'html_definition' => '\DocuSign\eSign\Model\DocumentHtmlDefinition', 'include_in_download' => 'string', - 'is_dynamic_xfa' => 'bool', - 'is_static_xfa' => 'bool', 'match_boxes' => '\DocuSign\eSign\Model\MatchBox[]', 'name' => 'string', - 'ocr_requests' => '\DocuSign\eSign\Model\OcrRequest[]', 'order' => 'string', - 'page_count' => 'string', 'pages' => 'string', - 'page_sizes' => '\DocuSign\eSign\Model\PageSize[]', 'password' => 'string', - 'pdf_fields_data' => 'string', 'pdf_form_field_option' => 'string', - 'pdf_widgets_base64' => 'string', 'remote_url' => 'string', 'signer_must_acknowledge' => 'string', 'signer_must_acknowledge_use_account_default' => 'bool', @@ -87,13 +83,62 @@ class Document implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'apply_anchor_tabs' => null, + 'display' => null, + 'document_base64' => null, + 'document_fields' => null, + 'document_id' => null, + 'encrypted_with_key_manager' => null, + 'file_extension' => null, + 'file_format_hint' => null, + 'html_definition' => null, + 'include_in_download' => null, + 'match_boxes' => null, + 'name' => null, + 'order' => null, + 'pages' => null, + 'password' => null, + 'pdf_form_field_option' => null, + 'remote_url' => null, + 'signer_must_acknowledge' => null, + 'signer_must_acknowledge_use_account_default' => null, + 'tabs' => null, + 'template_locked' => null, + 'template_required' => null, + 'transform_pdf_fields' => null, + 'uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -107,19 +152,12 @@ public static function swaggerTypes() 'file_format_hint' => 'fileFormatHint', 'html_definition' => 'htmlDefinition', 'include_in_download' => 'includeInDownload', - 'is_dynamic_xfa' => 'isDynamicXfa', - 'is_static_xfa' => 'isStaticXfa', 'match_boxes' => 'matchBoxes', 'name' => 'name', - 'ocr_requests' => 'ocrRequests', 'order' => 'order', - 'page_count' => 'pageCount', 'pages' => 'pages', - 'page_sizes' => 'pageSizes', 'password' => 'password', - 'pdf_fields_data' => 'pdfFieldsData', 'pdf_form_field_option' => 'pdfFormFieldOption', - 'pdf_widgets_base64' => 'pdfWidgetsBase64', 'remote_url' => 'remoteUrl', 'signer_must_acknowledge' => 'signerMustAcknowledge', 'signer_must_acknowledge_use_account_default' => 'signerMustAcknowledgeUseAccountDefault', @@ -130,9 +168,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -146,19 +184,12 @@ public static function swaggerTypes() 'file_format_hint' => 'setFileFormatHint', 'html_definition' => 'setHtmlDefinition', 'include_in_download' => 'setIncludeInDownload', - 'is_dynamic_xfa' => 'setIsDynamicXfa', - 'is_static_xfa' => 'setIsStaticXfa', 'match_boxes' => 'setMatchBoxes', 'name' => 'setName', - 'ocr_requests' => 'setOcrRequests', 'order' => 'setOrder', - 'page_count' => 'setPageCount', 'pages' => 'setPages', - 'page_sizes' => 'setPageSizes', 'password' => 'setPassword', - 'pdf_fields_data' => 'setPdfFieldsData', 'pdf_form_field_option' => 'setPdfFormFieldOption', - 'pdf_widgets_base64' => 'setPdfWidgetsBase64', 'remote_url' => 'setRemoteUrl', 'signer_must_acknowledge' => 'setSignerMustAcknowledge', 'signer_must_acknowledge_use_account_default' => 'setSignerMustAcknowledgeUseAccountDefault', @@ -169,9 +200,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -185,19 +216,12 @@ public static function swaggerTypes() 'file_format_hint' => 'getFileFormatHint', 'html_definition' => 'getHtmlDefinition', 'include_in_download' => 'getIncludeInDownload', - 'is_dynamic_xfa' => 'getIsDynamicXfa', - 'is_static_xfa' => 'getIsStaticXfa', 'match_boxes' => 'getMatchBoxes', 'name' => 'getName', - 'ocr_requests' => 'getOcrRequests', 'order' => 'getOrder', - 'page_count' => 'getPageCount', 'pages' => 'getPages', - 'page_sizes' => 'getPageSizes', 'password' => 'getPassword', - 'pdf_fields_data' => 'getPdfFieldsData', 'pdf_form_field_option' => 'getPdfFormFieldOption', - 'pdf_widgets_base64' => 'getPdfWidgetsBase64', 'remote_url' => 'getRemoteUrl', 'signer_must_acknowledge' => 'getSignerMustAcknowledge', 'signer_must_acknowledge_use_account_default' => 'getSignerMustAcknowledgeUseAccountDefault', @@ -208,34 +232,63 @@ public static function swaggerTypes() 'uri' => 'getUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -249,19 +302,12 @@ public function __construct(array $data = 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['is_dynamic_xfa'] = isset($data['is_dynamic_xfa']) ? $data['is_dynamic_xfa'] : null; - $this->container['is_static_xfa'] = isset($data['is_static_xfa']) ? $data['is_static_xfa'] : null; $this->container['match_boxes'] = isset($data['match_boxes']) ? $data['match_boxes'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; - $this->container['ocr_requests'] = isset($data['ocr_requests']) ? $data['ocr_requests'] : null; $this->container['order'] = isset($data['order']) ? $data['order'] : null; - $this->container['page_count'] = isset($data['page_count']) ? $data['page_count'] : null; $this->container['pages'] = isset($data['pages']) ? $data['pages'] : null; - $this->container['page_sizes'] = isset($data['page_sizes']) ? $data['page_sizes'] : null; $this->container['password'] = isset($data['password']) ? $data['password'] : null; - $this->container['pdf_fields_data'] = isset($data['pdf_fields_data']) ? $data['pdf_fields_data'] : null; $this->container['pdf_form_field_option'] = isset($data['pdf_form_field_option']) ? $data['pdf_form_field_option'] : null; - $this->container['pdf_widgets_base64'] = isset($data['pdf_widgets_base64']) ? $data['pdf_widgets_base64'] : null; $this->container['remote_url'] = isset($data['remote_url']) ? $data['remote_url'] : null; $this->container['signer_must_acknowledge'] = isset($data['signer_must_acknowledge']) ? $data['signer_must_acknowledge'] : null; $this->container['signer_must_acknowledge_use_account_default'] = isset($data['signer_must_acknowledge_use_account_default']) ? $data['signer_must_acknowledge_use_account_default'] : null; @@ -273,30 +319,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets apply_anchor_tabs + * * @return string */ public function getApplyAnchorTabs() @@ -306,7 +354,9 @@ public function getApplyAnchorTabs() /** * Sets apply_anchor_tabs + * * @param string $apply_anchor_tabs Reserved: TBD + * * @return $this */ public function setApplyAnchorTabs($apply_anchor_tabs) @@ -318,6 +368,7 @@ public function setApplyAnchorTabs($apply_anchor_tabs) /** * Gets display + * * @return string */ public function getDisplay() @@ -327,7 +378,9 @@ public function getDisplay() /** * Sets display + * * @param string $display + * * @return $this */ public function setDisplay($display) @@ -339,6 +392,7 @@ public function setDisplay($display) /** * Gets document_base64 + * * @return string */ public function getDocumentBase64() @@ -348,7 +402,9 @@ 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. + * * @return $this */ public function setDocumentBase64($document_base64) @@ -360,6 +416,7 @@ public function setDocumentBase64($document_base64) /** * Gets document_fields + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getDocumentFields() @@ -369,7 +426,9 @@ public function getDocumentFields() /** * Sets document_fields + * * @param \DocuSign\eSign\Model\NameValue[] $document_fields + * * @return $this */ public function setDocumentFields($document_fields) @@ -381,6 +440,7 @@ public function setDocumentFields($document_fields) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -390,7 +450,9 @@ public function getDocumentId() /** * 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) @@ -402,6 +464,7 @@ public function setDocumentId($document_id) /** * Gets encrypted_with_key_manager + * * @return string */ public function getEncryptedWithKeyManager() @@ -411,7 +474,9 @@ public function getEncryptedWithKeyManager() /** * Sets encrypted_with_key_manager + * * @param string $encrypted_with_key_manager When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. + * * @return $this */ public function setEncryptedWithKeyManager($encrypted_with_key_manager) @@ -423,6 +488,7 @@ public function setEncryptedWithKeyManager($encrypted_with_key_manager) /** * Gets file_extension + * * @return string */ public function getFileExtension() @@ -432,7 +498,9 @@ public function getFileExtension() /** * Sets file_extension + * * @param string $file_extension The file extension type of the document. If the document is not a PDF it is converted to a PDF. + * * @return $this */ public function setFileExtension($file_extension) @@ -444,6 +512,7 @@ public function setFileExtension($file_extension) /** * Gets file_format_hint + * * @return string */ public function getFileFormatHint() @@ -453,7 +522,9 @@ public function getFileFormatHint() /** * Sets file_format_hint + * * @param string $file_format_hint + * * @return $this */ public function setFileFormatHint($file_format_hint) @@ -465,6 +536,7 @@ public function setFileFormatHint($file_format_hint) /** * Gets html_definition + * * @return \DocuSign\eSign\Model\DocumentHtmlDefinition */ public function getHtmlDefinition() @@ -474,7 +546,9 @@ public function getHtmlDefinition() /** * Sets html_definition - * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $html_definition + * + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $html_definition html_definition + * * @return $this */ public function setHtmlDefinition($html_definition) @@ -486,6 +560,7 @@ public function setHtmlDefinition($html_definition) /** * Gets include_in_download + * * @return string */ public function getIncludeInDownload() @@ -495,7 +570,9 @@ public function getIncludeInDownload() /** * Sets include_in_download + * * @param string $include_in_download + * * @return $this */ public function setIncludeInDownload($include_in_download) @@ -505,50 +582,9 @@ public function setIncludeInDownload($include_in_download) return $this; } - /** - * Gets is_dynamic_xfa - * @return bool - */ - public function getIsDynamicXfa() - { - return $this->container['is_dynamic_xfa']; - } - - /** - * Sets is_dynamic_xfa - * @param bool $is_dynamic_xfa - * @return $this - */ - public function setIsDynamicXfa($is_dynamic_xfa) - { - $this->container['is_dynamic_xfa'] = $is_dynamic_xfa; - - return $this; - } - - /** - * Gets is_static_xfa - * @return bool - */ - public function getIsStaticXfa() - { - return $this->container['is_static_xfa']; - } - - /** - * Sets is_static_xfa - * @param bool $is_static_xfa - * @return $this - */ - public function setIsStaticXfa($is_static_xfa) - { - $this->container['is_static_xfa'] = $is_static_xfa; - - return $this; - } - /** * Gets match_boxes + * * @return \DocuSign\eSign\Model\MatchBox[] */ public function getMatchBoxes() @@ -558,7 +594,9 @@ public function getMatchBoxes() /** * Sets match_boxes + * * @param \DocuSign\eSign\Model\MatchBox[] $match_boxes Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox. + * * @return $this */ public function setMatchBoxes($match_boxes) @@ -570,6 +608,7 @@ public function setMatchBoxes($match_boxes) /** * Gets name + * * @return string */ public function getName() @@ -579,7 +618,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -589,29 +630,9 @@ public function setName($name) return $this; } - /** - * Gets ocr_requests - * @return \DocuSign\eSign\Model\OcrRequest[] - */ - public function getOcrRequests() - { - return $this->container['ocr_requests']; - } - - /** - * Sets ocr_requests - * @param \DocuSign\eSign\Model\OcrRequest[] $ocr_requests - * @return $this - */ - public function setOcrRequests($ocr_requests) - { - $this->container['ocr_requests'] = $ocr_requests; - - return $this; - } - /** * Gets order + * * @return string */ public function getOrder() @@ -621,7 +642,9 @@ public function getOrder() /** * Sets order + * * @param string $order + * * @return $this */ public function setOrder($order) @@ -631,29 +654,9 @@ public function setOrder($order) return $this; } - /** - * Gets page_count - * @return string - */ - public function getPageCount() - { - return $this->container['page_count']; - } - - /** - * Sets page_count - * @param string $page_count - * @return $this - */ - public function setPageCount($page_count) - { - $this->container['page_count'] = $page_count; - - return $this; - } - /** * Gets pages + * * @return string */ public function getPages() @@ -663,7 +666,9 @@ public function getPages() /** * Sets pages + * * @param string $pages + * * @return $this */ public function setPages($pages) @@ -673,29 +678,9 @@ public function setPages($pages) return $this; } - /** - * Gets page_sizes - * @return \DocuSign\eSign\Model\PageSize[] - */ - public function getPageSizes() - { - return $this->container['page_sizes']; - } - - /** - * Sets page_sizes - * @param \DocuSign\eSign\Model\PageSize[] $page_sizes - * @return $this - */ - public function setPageSizes($page_sizes) - { - $this->container['page_sizes'] = $page_sizes; - - return $this; - } - /** * Gets password + * * @return string */ public function getPassword() @@ -705,7 +690,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -715,29 +702,9 @@ public function setPassword($password) return $this; } - /** - * Gets pdf_fields_data - * @return string - */ - public function getPdfFieldsData() - { - return $this->container['pdf_fields_data']; - } - - /** - * Sets pdf_fields_data - * @param string $pdf_fields_data - * @return $this - */ - public function setPdfFieldsData($pdf_fields_data) - { - $this->container['pdf_fields_data'] = $pdf_fields_data; - - return $this; - } - /** * Gets pdf_form_field_option + * * @return string */ public function getPdfFormFieldOption() @@ -747,7 +714,9 @@ public function getPdfFormFieldOption() /** * Sets pdf_form_field_option + * * @param string $pdf_form_field_option + * * @return $this */ public function setPdfFormFieldOption($pdf_form_field_option) @@ -757,29 +726,9 @@ public function setPdfFormFieldOption($pdf_form_field_option) return $this; } - /** - * Gets pdf_widgets_base64 - * @return string - */ - public function getPdfWidgetsBase64() - { - return $this->container['pdf_widgets_base64']; - } - - /** - * Sets pdf_widgets_base64 - * @param string $pdf_widgets_base64 - * @return $this - */ - public function setPdfWidgetsBase64($pdf_widgets_base64) - { - $this->container['pdf_widgets_base64'] = $pdf_widgets_base64; - - return $this; - } - /** * Gets remote_url + * * @return string */ public function getRemoteUrl() @@ -789,7 +738,9 @@ public function getRemoteUrl() /** * Sets remote_url + * * @param string $remote_url The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. + * * @return $this */ public function setRemoteUrl($remote_url) @@ -801,6 +752,7 @@ public function setRemoteUrl($remote_url) /** * Gets signer_must_acknowledge + * * @return string */ public function getSignerMustAcknowledge() @@ -810,7 +762,9 @@ public function getSignerMustAcknowledge() /** * Sets signer_must_acknowledge + * * @param string $signer_must_acknowledge + * * @return $this */ public function setSignerMustAcknowledge($signer_must_acknowledge) @@ -822,6 +776,7 @@ public function setSignerMustAcknowledge($signer_must_acknowledge) /** * Gets signer_must_acknowledge_use_account_default + * * @return bool */ public function getSignerMustAcknowledgeUseAccountDefault() @@ -831,7 +786,9 @@ public function getSignerMustAcknowledgeUseAccountDefault() /** * Sets signer_must_acknowledge_use_account_default + * * @param bool $signer_must_acknowledge_use_account_default + * * @return $this */ public function setSignerMustAcknowledgeUseAccountDefault($signer_must_acknowledge_use_account_default) @@ -843,6 +800,7 @@ public function setSignerMustAcknowledgeUseAccountDefault($signer_must_acknowled /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -852,7 +810,9 @@ public function getTabs() /** * Sets tabs - * @param \DocuSign\eSign\Model\Tabs $tabs + * + * @param \DocuSign\eSign\Model\Tabs $tabs tabs + * * @return $this */ public function setTabs($tabs) @@ -864,6 +824,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -873,7 +834,9 @@ public function getTemplateLocked() /** * 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) @@ -885,6 +848,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -894,7 +858,9 @@ public function getTemplateRequired() /** * 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) @@ -906,6 +872,7 @@ public function setTemplateRequired($template_required) /** * Gets transform_pdf_fields + * * @return string */ public function getTransformPdfFields() @@ -915,7 +882,9 @@ public function getTransformPdfFields() /** * Sets transform_pdf_fields + * * @param string $transform_pdf_fields When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. + * * @return $this */ public function setTransformPdfFields($transform_pdf_fields) @@ -927,6 +896,7 @@ public function setTransformPdfFields($transform_pdf_fields) /** * Gets uri + * * @return string */ public function getUri() @@ -936,7 +906,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -947,7 +919,9 @@ public function setUri($uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -957,7 +931,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -967,8 +943,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -982,7 +960,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -992,16 +972,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentFieldsInformation.php b/src/Model/DocumentFieldsInformation.php index 686253a1..1aa858ca 100644 --- a/src/Model/DocumentFieldsInformation.php +++ b/src/Model/DocumentFieldsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentFieldsInformation Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentFieldsInformation implements ArrayAccess +class DocumentFieldsInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentFieldsInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'document_fields' => '\DocuSign\eSign\Model\NameValue[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'document_fields' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'document_fields' => 'documentFields' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'document_fields' => 'setDocumentFields' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'document_fields' => 'getDocumentFields' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets document_fields + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getDocumentFields() @@ -156,7 +216,9 @@ 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. + * * @return $this */ public function setDocumentFields($document_fields) @@ -167,7 +229,9 @@ public function setDocumentFields($document_fields) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentHtmlCollapsibleDisplaySettings.php b/src/Model/DocumentHtmlCollapsibleDisplaySettings.php index 24345633..3a611a00 100644 --- a/src/Model/DocumentHtmlCollapsibleDisplaySettings.php +++ b/src/Model/DocumentHtmlCollapsibleDisplaySettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentHtmlCollapsibleDisplaySettings Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentHtmlCollapsibleDisplaySettings implements ArrayAccess +class DocumentHtmlCollapsibleDisplaySettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentHtmlCollapsibleDisplaySettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class DocumentHtmlCollapsibleDisplaySettings implements ArrayAccess 'outer_label_and_arrow_style' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'arrow_closed' => null, + 'arrow_color' => null, + 'arrow_location' => null, + 'arrow_open' => null, + 'arrow_size' => null, + 'arrow_style' => null, + 'container_style' => null, + 'label_style' => null, + 'only_arrow_is_clickable' => null, + 'outer_label_and_arrow_style' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'outer_label_and_arrow_style' => 'outerLabelAndArrowStyle' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'outer_label_and_arrow_style' => 'setOuterLabelAndArrowStyle' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'outer_label_and_arrow_style' => 'getOuterLabelAndArrowStyle' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets arrow_closed + * * @return string */ public function getArrowClosed() @@ -201,7 +270,9 @@ public function getArrowClosed() /** * Sets arrow_closed + * * @param string $arrow_closed + * * @return $this */ public function setArrowClosed($arrow_closed) @@ -213,6 +284,7 @@ public function setArrowClosed($arrow_closed) /** * Gets arrow_color + * * @return string */ public function getArrowColor() @@ -222,7 +294,9 @@ public function getArrowColor() /** * Sets arrow_color + * * @param string $arrow_color + * * @return $this */ public function setArrowColor($arrow_color) @@ -234,6 +308,7 @@ public function setArrowColor($arrow_color) /** * Gets arrow_location + * * @return string */ public function getArrowLocation() @@ -243,7 +318,9 @@ public function getArrowLocation() /** * Sets arrow_location + * * @param string $arrow_location + * * @return $this */ public function setArrowLocation($arrow_location) @@ -255,6 +332,7 @@ public function setArrowLocation($arrow_location) /** * Gets arrow_open + * * @return string */ public function getArrowOpen() @@ -264,7 +342,9 @@ public function getArrowOpen() /** * Sets arrow_open + * * @param string $arrow_open + * * @return $this */ public function setArrowOpen($arrow_open) @@ -276,6 +356,7 @@ public function setArrowOpen($arrow_open) /** * Gets arrow_size + * * @return string */ public function getArrowSize() @@ -285,7 +366,9 @@ public function getArrowSize() /** * Sets arrow_size + * * @param string $arrow_size + * * @return $this */ public function setArrowSize($arrow_size) @@ -297,6 +380,7 @@ public function setArrowSize($arrow_size) /** * Gets arrow_style + * * @return string */ public function getArrowStyle() @@ -306,7 +390,9 @@ public function getArrowStyle() /** * Sets arrow_style + * * @param string $arrow_style + * * @return $this */ public function setArrowStyle($arrow_style) @@ -318,6 +404,7 @@ public function setArrowStyle($arrow_style) /** * Gets container_style + * * @return string */ public function getContainerStyle() @@ -327,7 +414,9 @@ public function getContainerStyle() /** * Sets container_style + * * @param string $container_style + * * @return $this */ public function setContainerStyle($container_style) @@ -339,6 +428,7 @@ public function setContainerStyle($container_style) /** * Gets label_style + * * @return string */ public function getLabelStyle() @@ -348,7 +438,9 @@ public function getLabelStyle() /** * Sets label_style + * * @param string $label_style + * * @return $this */ public function setLabelStyle($label_style) @@ -360,6 +452,7 @@ public function setLabelStyle($label_style) /** * Gets only_arrow_is_clickable + * * @return bool */ public function getOnlyArrowIsClickable() @@ -369,7 +462,9 @@ public function getOnlyArrowIsClickable() /** * Sets only_arrow_is_clickable + * * @param bool $only_arrow_is_clickable + * * @return $this */ public function setOnlyArrowIsClickable($only_arrow_is_clickable) @@ -381,6 +476,7 @@ public function setOnlyArrowIsClickable($only_arrow_is_clickable) /** * Gets outer_label_and_arrow_style + * * @return string */ public function getOuterLabelAndArrowStyle() @@ -390,7 +486,9 @@ public function getOuterLabelAndArrowStyle() /** * Sets outer_label_and_arrow_style + * * @param string $outer_label_and_arrow_style + * * @return $this */ public function setOuterLabelAndArrowStyle($outer_label_and_arrow_style) @@ -401,7 +499,9 @@ public function setOuterLabelAndArrowStyle($outer_label_and_arrow_style) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentHtmlDefinition.php b/src/Model/DocumentHtmlDefinition.php index bf9dfdc4..75e0fd45 100644 --- a/src/Model/DocumentHtmlDefinition.php +++ b/src/Model/DocumentHtmlDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentHtmlDefinition Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentHtmlDefinition implements ArrayAccess +class DocumentHtmlDefinition implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentHtmlDefinition'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -67,13 +70,49 @@ class DocumentHtmlDefinition implements ArrayAccess 'source' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'display_anchor_prefix' => null, + 'display_anchors' => null, + 'display_order' => null, + 'display_page_number' => null, + 'document_guid' => null, + 'document_id' => null, + 'header_label' => null, + 'max_screen_width' => null, + 'remove_empty_tags' => null, + 'show_mobile_optimized_toggle' => null, + 'source' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -90,9 +129,9 @@ public static function swaggerTypes() 'source' => 'source' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -109,9 +148,9 @@ public static function swaggerTypes() 'source' => 'setSource' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -128,34 +167,63 @@ public static function swaggerTypes() 'source' => 'getSource' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -173,30 +241,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets display_anchor_prefix + * * @return string */ public function getDisplayAnchorPrefix() @@ -206,7 +276,9 @@ public function getDisplayAnchorPrefix() /** * Sets display_anchor_prefix + * * @param string $display_anchor_prefix + * * @return $this */ public function setDisplayAnchorPrefix($display_anchor_prefix) @@ -218,6 +290,7 @@ public function setDisplayAnchorPrefix($display_anchor_prefix) /** * Gets display_anchors + * * @return \DocuSign\eSign\Model\DocumentHtmlDisplayAnchor[] */ public function getDisplayAnchors() @@ -227,7 +300,9 @@ public function getDisplayAnchors() /** * Sets display_anchors + * * @param \DocuSign\eSign\Model\DocumentHtmlDisplayAnchor[] $display_anchors + * * @return $this */ public function setDisplayAnchors($display_anchors) @@ -239,6 +314,7 @@ public function setDisplayAnchors($display_anchors) /** * Gets display_order + * * @return string */ public function getDisplayOrder() @@ -248,7 +324,9 @@ public function getDisplayOrder() /** * Sets display_order + * * @param string $display_order + * * @return $this */ public function setDisplayOrder($display_order) @@ -260,6 +338,7 @@ public function setDisplayOrder($display_order) /** * Gets display_page_number + * * @return string */ public function getDisplayPageNumber() @@ -269,7 +348,9 @@ public function getDisplayPageNumber() /** * Sets display_page_number + * * @param string $display_page_number + * * @return $this */ public function setDisplayPageNumber($display_page_number) @@ -281,6 +362,7 @@ public function setDisplayPageNumber($display_page_number) /** * Gets document_guid + * * @return string */ public function getDocumentGuid() @@ -290,7 +372,9 @@ public function getDocumentGuid() /** * Sets document_guid + * * @param string $document_guid + * * @return $this */ public function setDocumentGuid($document_guid) @@ -302,6 +386,7 @@ public function setDocumentGuid($document_guid) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -311,7 +396,9 @@ public function getDocumentId() /** * 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) @@ -323,6 +410,7 @@ public function setDocumentId($document_id) /** * Gets header_label + * * @return string */ public function getHeaderLabel() @@ -332,7 +420,9 @@ public function getHeaderLabel() /** * Sets header_label + * * @param string $header_label + * * @return $this */ public function setHeaderLabel($header_label) @@ -344,6 +434,7 @@ public function setHeaderLabel($header_label) /** * Gets max_screen_width + * * @return string */ public function getMaxScreenWidth() @@ -353,7 +444,9 @@ public function getMaxScreenWidth() /** * Sets max_screen_width + * * @param string $max_screen_width + * * @return $this */ public function setMaxScreenWidth($max_screen_width) @@ -365,6 +458,7 @@ public function setMaxScreenWidth($max_screen_width) /** * Gets remove_empty_tags + * * @return string */ public function getRemoveEmptyTags() @@ -374,7 +468,9 @@ public function getRemoveEmptyTags() /** * Sets remove_empty_tags + * * @param string $remove_empty_tags + * * @return $this */ public function setRemoveEmptyTags($remove_empty_tags) @@ -386,6 +482,7 @@ public function setRemoveEmptyTags($remove_empty_tags) /** * Gets show_mobile_optimized_toggle + * * @return string */ public function getShowMobileOptimizedToggle() @@ -395,7 +492,9 @@ public function getShowMobileOptimizedToggle() /** * Sets show_mobile_optimized_toggle + * * @param string $show_mobile_optimized_toggle + * * @return $this */ public function setShowMobileOptimizedToggle($show_mobile_optimized_toggle) @@ -407,6 +506,7 @@ public function setShowMobileOptimizedToggle($show_mobile_optimized_toggle) /** * Gets source + * * @return string */ public function getSource() @@ -416,7 +516,9 @@ public function getSource() /** * Sets source + * * @param string $source + * * @return $this */ public function setSource($source) @@ -427,7 +529,9 @@ public function setSource($source) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -437,7 +541,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -447,8 +553,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -462,7 +570,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -472,16 +582,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentHtmlDefinitionOriginal.php b/src/Model/DocumentHtmlDefinitionOriginal.php index efc5eb21..e9d58feb 100644 --- a/src/Model/DocumentHtmlDefinitionOriginal.php +++ b/src/Model/DocumentHtmlDefinitionOriginal.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentHtmlDefinitionOriginal Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentHtmlDefinitionOriginal implements ArrayAccess +class DocumentHtmlDefinitionOriginal implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentHtmlDefinitionOriginal'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class DocumentHtmlDefinitionOriginal implements ArrayAccess 'html_definition' => '\DocuSign\eSign\Model\DocumentHtmlDefinition' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'document_id' => null, + 'document_id_guid' => null, + 'html_definition' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'html_definition' => 'htmlDefinition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'html_definition' => 'setHtmlDefinition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'html_definition' => 'getHtmlDefinition' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -166,7 +228,9 @@ public function getDocumentId() /** * 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) @@ -178,6 +242,7 @@ public function setDocumentId($document_id) /** * Gets document_id_guid + * * @return string */ public function getDocumentIdGuid() @@ -187,7 +252,9 @@ public function getDocumentIdGuid() /** * Sets document_id_guid + * * @param string $document_id_guid + * * @return $this */ public function setDocumentIdGuid($document_id_guid) @@ -199,6 +266,7 @@ public function setDocumentIdGuid($document_id_guid) /** * Gets html_definition + * * @return \DocuSign\eSign\Model\DocumentHtmlDefinition */ public function getHtmlDefinition() @@ -208,7 +276,9 @@ public function getHtmlDefinition() /** * Sets html_definition - * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $html_definition + * + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $html_definition html_definition + * * @return $this */ public function setHtmlDefinition($html_definition) @@ -219,7 +289,9 @@ public function setHtmlDefinition($html_definition) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentHtmlDefinitionOriginals.php b/src/Model/DocumentHtmlDefinitionOriginals.php index fc260f60..1c7e418a 100644 --- a/src/Model/DocumentHtmlDefinitionOriginals.php +++ b/src/Model/DocumentHtmlDefinitionOriginals.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentHtmlDefinitionOriginals Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentHtmlDefinitionOriginals implements ArrayAccess +class DocumentHtmlDefinitionOriginals implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentHtmlDefinitionOriginals'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'html_definitions' => '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginal[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'html_definitions' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ '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' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets html_definitions + * * @return \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginal[] */ public function getHtmlDefinitions() @@ -156,7 +216,9 @@ public function getHtmlDefinitions() /** * Sets html_definitions + * * @param \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginal[] $html_definitions + * * @return $this */ public function setHtmlDefinitions($html_definitions) @@ -167,7 +229,9 @@ public function setHtmlDefinitions($html_definitions) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentHtmlDefinitions.php b/src/Model/DocumentHtmlDefinitions.php index 19f501b0..d630ef4f 100644 --- a/src/Model/DocumentHtmlDefinitions.php +++ b/src/Model/DocumentHtmlDefinitions.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentHtmlDefinitions Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentHtmlDefinitions implements ArrayAccess +class DocumentHtmlDefinitions implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentHtmlDefinitions'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'html_definitions' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'html_definitions' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ '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' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets html_definitions + * * @return string[] */ public function getHtmlDefinitions() @@ -156,7 +216,9 @@ public function getHtmlDefinitions() /** * Sets html_definitions + * * @param string[] $html_definitions + * * @return $this */ public function setHtmlDefinitions($html_definitions) @@ -167,7 +229,9 @@ public function setHtmlDefinitions($html_definitions) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentHtmlDisplayAnchor.php b/src/Model/DocumentHtmlDisplayAnchor.php index 4cace019..41a3c454 100644 --- a/src/Model/DocumentHtmlDisplayAnchor.php +++ b/src/Model/DocumentHtmlDisplayAnchor.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentHtmlDisplayAnchor Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentHtmlDisplayAnchor implements ArrayAccess +class DocumentHtmlDisplayAnchor implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentHtmlDisplayAnchor'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class DocumentHtmlDisplayAnchor implements ArrayAccess 'start_anchor' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'case_sensitive' => null, + 'display_settings' => null, + 'end_anchor' => null, + 'remove_end_anchor' => null, + 'remove_start_anchor' => null, + 'start_anchor' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'start_anchor' => 'startAnchor' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'start_anchor' => 'setStartAnchor' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'start_anchor' => 'getStartAnchor' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets case_sensitive + * * @return bool */ public function getCaseSensitive() @@ -181,7 +246,9 @@ public function getCaseSensitive() /** * Sets case_sensitive + * * @param bool $case_sensitive + * * @return $this */ public function setCaseSensitive($case_sensitive) @@ -193,6 +260,7 @@ public function setCaseSensitive($case_sensitive) /** * Gets display_settings + * * @return \DocuSign\eSign\Model\DocumentHtmlDisplaySettings */ public function getDisplaySettings() @@ -202,7 +270,9 @@ public function getDisplaySettings() /** * Sets display_settings - * @param \DocuSign\eSign\Model\DocumentHtmlDisplaySettings $display_settings + * + * @param \DocuSign\eSign\Model\DocumentHtmlDisplaySettings $display_settings display_settings + * * @return $this */ public function setDisplaySettings($display_settings) @@ -214,6 +284,7 @@ public function setDisplaySettings($display_settings) /** * Gets end_anchor + * * @return string */ public function getEndAnchor() @@ -223,7 +294,9 @@ public function getEndAnchor() /** * Sets end_anchor + * * @param string $end_anchor + * * @return $this */ public function setEndAnchor($end_anchor) @@ -235,6 +308,7 @@ public function setEndAnchor($end_anchor) /** * Gets remove_end_anchor + * * @return bool */ public function getRemoveEndAnchor() @@ -244,7 +318,9 @@ public function getRemoveEndAnchor() /** * Sets remove_end_anchor + * * @param bool $remove_end_anchor + * * @return $this */ public function setRemoveEndAnchor($remove_end_anchor) @@ -256,6 +332,7 @@ public function setRemoveEndAnchor($remove_end_anchor) /** * Gets remove_start_anchor + * * @return bool */ public function getRemoveStartAnchor() @@ -265,7 +342,9 @@ public function getRemoveStartAnchor() /** * Sets remove_start_anchor + * * @param bool $remove_start_anchor + * * @return $this */ public function setRemoveStartAnchor($remove_start_anchor) @@ -277,6 +356,7 @@ public function setRemoveStartAnchor($remove_start_anchor) /** * Gets start_anchor + * * @return string */ public function getStartAnchor() @@ -286,7 +366,9 @@ public function getStartAnchor() /** * Sets start_anchor + * * @param string $start_anchor + * * @return $this */ public function setStartAnchor($start_anchor) @@ -297,7 +379,9 @@ public function setStartAnchor($start_anchor) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentHtmlDisplaySettings.php b/src/Model/DocumentHtmlDisplaySettings.php index 03dfc7cc..f39f17e7 100644 --- a/src/Model/DocumentHtmlDisplaySettings.php +++ b/src/Model/DocumentHtmlDisplaySettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentHtmlDisplaySettings Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentHtmlDisplaySettings implements ArrayAccess +class DocumentHtmlDisplaySettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentHtmlDisplaySettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -68,13 +71,50 @@ class DocumentHtmlDisplaySettings implements ArrayAccess 'table_style' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'cell_style' => null, + 'collapsible_settings' => null, + 'display' => null, + 'display_label' => null, + 'display_order' => 'int32', + 'display_page_number' => 'int32', + 'hide_label_when_opened' => null, + 'inline_outer_style' => null, + 'label_when_opened' => null, + 'pre_label' => null, + 'scroll_to_top_when_opened' => null, + 'table_style' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -92,9 +132,9 @@ public static function swaggerTypes() 'table_style' => 'tableStyle' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,9 +152,9 @@ public static function swaggerTypes() 'table_style' => 'setTableStyle' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -132,34 +172,63 @@ public static function swaggerTypes() 'table_style' => 'getTableStyle' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -178,30 +247,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets cell_style + * * @return string */ public function getCellStyle() @@ -211,7 +282,9 @@ public function getCellStyle() /** * Sets cell_style + * * @param string $cell_style + * * @return $this */ public function setCellStyle($cell_style) @@ -223,6 +296,7 @@ public function setCellStyle($cell_style) /** * Gets collapsible_settings + * * @return \DocuSign\eSign\Model\DocumentHtmlCollapsibleDisplaySettings */ public function getCollapsibleSettings() @@ -232,7 +306,9 @@ public function getCollapsibleSettings() /** * Sets collapsible_settings - * @param \DocuSign\eSign\Model\DocumentHtmlCollapsibleDisplaySettings $collapsible_settings + * + * @param \DocuSign\eSign\Model\DocumentHtmlCollapsibleDisplaySettings $collapsible_settings collapsible_settings + * * @return $this */ public function setCollapsibleSettings($collapsible_settings) @@ -244,6 +320,7 @@ public function setCollapsibleSettings($collapsible_settings) /** * Gets display + * * @return string */ public function getDisplay() @@ -253,7 +330,9 @@ public function getDisplay() /** * Sets display + * * @param string $display + * * @return $this */ public function setDisplay($display) @@ -265,6 +344,7 @@ public function setDisplay($display) /** * Gets display_label + * * @return string */ public function getDisplayLabel() @@ -274,7 +354,9 @@ public function getDisplayLabel() /** * Sets display_label + * * @param string $display_label + * * @return $this */ public function setDisplayLabel($display_label) @@ -286,6 +368,7 @@ public function setDisplayLabel($display_label) /** * Gets display_order + * * @return int */ public function getDisplayOrder() @@ -295,7 +378,9 @@ public function getDisplayOrder() /** * Sets display_order + * * @param int $display_order + * * @return $this */ public function setDisplayOrder($display_order) @@ -307,6 +392,7 @@ public function setDisplayOrder($display_order) /** * Gets display_page_number + * * @return int */ public function getDisplayPageNumber() @@ -316,7 +402,9 @@ public function getDisplayPageNumber() /** * Sets display_page_number + * * @param int $display_page_number + * * @return $this */ public function setDisplayPageNumber($display_page_number) @@ -328,6 +416,7 @@ public function setDisplayPageNumber($display_page_number) /** * Gets hide_label_when_opened + * * @return bool */ public function getHideLabelWhenOpened() @@ -337,7 +426,9 @@ public function getHideLabelWhenOpened() /** * Sets hide_label_when_opened + * * @param bool $hide_label_when_opened + * * @return $this */ public function setHideLabelWhenOpened($hide_label_when_opened) @@ -349,6 +440,7 @@ public function setHideLabelWhenOpened($hide_label_when_opened) /** * Gets inline_outer_style + * * @return string */ public function getInlineOuterStyle() @@ -358,7 +450,9 @@ public function getInlineOuterStyle() /** * Sets inline_outer_style + * * @param string $inline_outer_style + * * @return $this */ public function setInlineOuterStyle($inline_outer_style) @@ -370,6 +464,7 @@ public function setInlineOuterStyle($inline_outer_style) /** * Gets label_when_opened + * * @return string */ public function getLabelWhenOpened() @@ -379,7 +474,9 @@ public function getLabelWhenOpened() /** * Sets label_when_opened + * * @param string $label_when_opened + * * @return $this */ public function setLabelWhenOpened($label_when_opened) @@ -391,6 +488,7 @@ public function setLabelWhenOpened($label_when_opened) /** * Gets pre_label + * * @return string */ public function getPreLabel() @@ -400,7 +498,9 @@ public function getPreLabel() /** * Sets pre_label + * * @param string $pre_label + * * @return $this */ public function setPreLabel($pre_label) @@ -412,6 +512,7 @@ public function setPreLabel($pre_label) /** * Gets scroll_to_top_when_opened + * * @return bool */ public function getScrollToTopWhenOpened() @@ -421,7 +522,9 @@ public function getScrollToTopWhenOpened() /** * Sets scroll_to_top_when_opened + * * @param bool $scroll_to_top_when_opened + * * @return $this */ public function setScrollToTopWhenOpened($scroll_to_top_when_opened) @@ -433,6 +536,7 @@ public function setScrollToTopWhenOpened($scroll_to_top_when_opened) /** * Gets table_style + * * @return string */ public function getTableStyle() @@ -442,7 +546,9 @@ public function getTableStyle() /** * Sets table_style + * * @param string $table_style + * * @return $this */ public function setTableStyle($table_style) @@ -453,7 +559,9 @@ public function setTableStyle($table_style) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -463,7 +571,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -473,8 +583,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -488,7 +600,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -498,16 +612,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentTemplate.php b/src/Model/DocumentTemplate.php index 324b97b1..8019214e 100644 --- a/src/Model/DocumentTemplate.php +++ b/src/Model/DocumentTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentTemplate Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentTemplate implements ArrayAccess +class DocumentTemplate implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentTemplate'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class DocumentTemplate implements ArrayAccess 'template_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'document_end_page' => null, + 'document_id' => null, + 'document_start_page' => null, + 'error_details' => null, + 'template_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'template_id' => 'templateId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'template_id' => 'setTemplateId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'template_id' => 'getTemplateId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets document_end_page + * * @return string */ public function getDocumentEndPage() @@ -176,7 +240,9 @@ public function getDocumentEndPage() /** * Sets document_end_page + * * @param string $document_end_page + * * @return $this */ public function setDocumentEndPage($document_end_page) @@ -188,6 +254,7 @@ public function setDocumentEndPage($document_end_page) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -197,7 +264,9 @@ public function getDocumentId() /** * 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) @@ -209,6 +278,7 @@ public function setDocumentId($document_id) /** * Gets document_start_page + * * @return string */ public function getDocumentStartPage() @@ -218,7 +288,9 @@ public function getDocumentStartPage() /** * Sets document_start_page + * * @param string $document_start_page + * * @return $this */ public function setDocumentStartPage($document_start_page) @@ -230,6 +302,7 @@ public function setDocumentStartPage($document_start_page) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -239,7 +312,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -251,6 +326,7 @@ public function setErrorDetails($error_details) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -260,7 +336,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -271,7 +349,9 @@ public function setTemplateId($template_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentTemplateList.php b/src/Model/DocumentTemplateList.php index 3f332809..13a03ed5 100644 --- a/src/Model/DocumentTemplateList.php +++ b/src/Model/DocumentTemplateList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentTemplateList Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentTemplateList implements ArrayAccess +class DocumentTemplateList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentTemplateList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'document_templates' => '\DocuSign\eSign\Model\DocumentTemplate[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'document_templates' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'document_templates' => 'documentTemplates' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'document_templates' => 'setDocumentTemplates' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'document_templates' => 'getDocumentTemplates' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets document_templates + * * @return \DocuSign\eSign\Model\DocumentTemplate[] */ public function getDocumentTemplates() @@ -156,7 +216,9 @@ public function getDocumentTemplates() /** * Sets document_templates + * * @param \DocuSign\eSign\Model\DocumentTemplate[] $document_templates + * * @return $this */ public function setDocumentTemplates($document_templates) @@ -167,7 +229,9 @@ public function setDocumentTemplates($document_templates) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentVisibility.php b/src/Model/DocumentVisibility.php index f873737f..565b57eb 100644 --- a/src/Model/DocumentVisibility.php +++ b/src/Model/DocumentVisibility.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentVisibility Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentVisibility implements ArrayAccess +class DocumentVisibility implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentVisibility'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class DocumentVisibility implements ArrayAccess 'visible' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'document_id' => null, + 'error_details' => null, + 'recipient_id' => null, + 'rights' => null, + 'visible' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'visible' => 'visible' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'visible' => 'setVisible' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'visible' => 'getVisible' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -176,7 +240,9 @@ public function getDocumentId() /** * 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) @@ -188,6 +254,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -197,7 +264,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -209,6 +278,7 @@ public function setErrorDetails($error_details) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -218,7 +288,9 @@ public function getRecipientId() /** * 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) @@ -230,6 +302,7 @@ public function setRecipientId($recipient_id) /** * Gets rights + * * @return string */ public function getRights() @@ -239,7 +312,9 @@ public function getRights() /** * Sets rights + * * @param string $rights + * * @return $this */ public function setRights($rights) @@ -251,6 +326,7 @@ public function setRights($rights) /** * Gets visible + * * @return string */ public function getVisible() @@ -260,7 +336,9 @@ public function getVisible() /** * Sets visible + * * @param string $visible + * * @return $this */ public function setVisible($visible) @@ -271,7 +349,9 @@ public function setVisible($visible) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DocumentVisibilityList.php b/src/Model/DocumentVisibilityList.php index d05b1e43..fc9aecb6 100644 --- a/src/Model/DocumentVisibilityList.php +++ b/src/Model/DocumentVisibilityList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DocumentVisibilityList Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DocumentVisibilityList implements ArrayAccess +class DocumentVisibilityList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'documentVisibilityList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'document_visibility' => '\DocuSign\eSign\Model\DocumentVisibility[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'document_visibility' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'document_visibility' => 'documentVisibility' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'document_visibility' => 'setDocumentVisibility' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'document_visibility' => 'getDocumentVisibility' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -156,7 +216,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -167,7 +229,9 @@ public function setDocumentVisibility($document_visibility) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DowngradRequestBillingInfoResponse.php b/src/Model/DowngradRequestBillingInfoResponse.php new file mode 100644 index 00000000..65f34455 --- /dev/null +++ b/src/Model/DowngradRequestBillingInfoResponse.php @@ -0,0 +1,330 @@ + '\DocuSign\eSign\Model\DowngradePlanUpdateResponse', + 'payment_method' => 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'downgrade_plan_information' => null, + 'payment_method' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'downgrade_plan_information' => 'downgradePlanInformation', + 'payment_method' => 'paymentMethod' + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'downgrade_plan_information' => 'setDowngradePlanInformation', + 'payment_method' => 'setPaymentMethod' + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'downgrade_plan_information' => 'getDowngradePlanInformation', + 'payment_method' => 'getPaymentMethod' + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + + + + + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->container['downgrade_plan_information'] = isset($data['downgrade_plan_information']) ? $data['downgrade_plan_information'] : null; + $this->container['payment_method'] = isset($data['payment_method']) ? $data['payment_method'] : null; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + + /** + * Gets downgrade_plan_information + * + * @return \DocuSign\eSign\Model\DowngradePlanUpdateResponse + */ + public function getDowngradePlanInformation() + { + return $this->container['downgrade_plan_information']; + } + + /** + * Sets downgrade_plan_information + * + * @param \DocuSign\eSign\Model\DowngradePlanUpdateResponse $downgrade_plan_information downgrade_plan_information + * + * @return $this + */ + public function setDowngradePlanInformation($downgrade_plan_information) + { + $this->container['downgrade_plan_information'] = $downgrade_plan_information; + + return $this; + } + + /** + * Gets payment_method + * + * @return string + */ + public function getPaymentMethod() + { + return $this->container['payment_method']; + } + + /** + * Sets payment_method + * + * @param string $payment_method + * + * @return $this + */ + public function setPaymentMethod($payment_method) + { + $this->container['payment_method'] = $payment_method; + + 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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); + } + + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} + diff --git a/src/Model/DowngradeBillingPlanInformation.php b/src/Model/DowngradeBillingPlanInformation.php index c69512fa..2827dc35 100644 --- a/src/Model/DowngradeBillingPlanInformation.php +++ b/src/Model/DowngradeBillingPlanInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DowngradeBillingPlanInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DowngradeBillingPlanInformation implements ArrayAccess +class DowngradeBillingPlanInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'downgradeBillingPlanInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class DowngradeBillingPlanInformation implements ArrayAccess 'plan_information' => '\DocuSign\eSign\Model\PlanInformation' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'downgrade_event_type' => null, + 'plan_information' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'plan_information' => 'planInformation' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'plan_information' => 'setPlanInformation' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'plan_information' => 'getPlanInformation' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets downgrade_event_type + * * @return string */ public function getDowngradeEventType() @@ -161,7 +222,9 @@ public function getDowngradeEventType() /** * Sets downgrade_event_type + * * @param string $downgrade_event_type + * * @return $this */ public function setDowngradeEventType($downgrade_event_type) @@ -173,6 +236,7 @@ public function setDowngradeEventType($downgrade_event_type) /** * Gets plan_information + * * @return \DocuSign\eSign\Model\PlanInformation */ public function getPlanInformation() @@ -182,7 +246,9 @@ public function getPlanInformation() /** * Sets plan_information - * @param \DocuSign\eSign\Model\PlanInformation $plan_information + * + * @param \DocuSign\eSign\Model\PlanInformation $plan_information plan_information + * * @return $this */ public function setPlanInformation($plan_information) @@ -193,7 +259,9 @@ public function setPlanInformation($plan_information) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/DowngradePlanUpdateResponse.php b/src/Model/DowngradePlanUpdateResponse.php index 03e4576f..614bd8c0 100644 --- a/src/Model/DowngradePlanUpdateResponse.php +++ b/src/Model/DowngradePlanUpdateResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * DowngradePlanUpdateResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class DowngradePlanUpdateResponse implements ArrayAccess +class DowngradePlanUpdateResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'downgradePlanUpdateResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class DowngradePlanUpdateResponse implements ArrayAccess 'message' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_payment_method' => null, + 'downgrade_effective_date' => null, + 'downgrade_payment_cycle' => null, + 'downgrade_plan_id' => null, + 'downgrade_plan_name' => null, + 'downgrade_request_status' => null, + 'message' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'message' => 'message' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'message' => 'setMessage' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'message' => 'getMessage' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_payment_method + * * @return string */ public function getAccountPaymentMethod() @@ -186,7 +252,9 @@ public function getAccountPaymentMethod() /** * Sets account_payment_method + * * @param string $account_payment_method + * * @return $this */ public function setAccountPaymentMethod($account_payment_method) @@ -198,6 +266,7 @@ public function setAccountPaymentMethod($account_payment_method) /** * Gets downgrade_effective_date + * * @return string */ public function getDowngradeEffectiveDate() @@ -207,7 +276,9 @@ public function getDowngradeEffectiveDate() /** * Sets downgrade_effective_date + * * @param string $downgrade_effective_date + * * @return $this */ public function setDowngradeEffectiveDate($downgrade_effective_date) @@ -219,6 +290,7 @@ public function setDowngradeEffectiveDate($downgrade_effective_date) /** * Gets downgrade_payment_cycle + * * @return string */ public function getDowngradePaymentCycle() @@ -228,7 +300,9 @@ public function getDowngradePaymentCycle() /** * Sets downgrade_payment_cycle + * * @param string $downgrade_payment_cycle + * * @return $this */ public function setDowngradePaymentCycle($downgrade_payment_cycle) @@ -240,6 +314,7 @@ public function setDowngradePaymentCycle($downgrade_payment_cycle) /** * Gets downgrade_plan_id + * * @return string */ public function getDowngradePlanId() @@ -249,7 +324,9 @@ public function getDowngradePlanId() /** * Sets downgrade_plan_id + * * @param string $downgrade_plan_id + * * @return $this */ public function setDowngradePlanId($downgrade_plan_id) @@ -261,6 +338,7 @@ public function setDowngradePlanId($downgrade_plan_id) /** * Gets downgrade_plan_name + * * @return string */ public function getDowngradePlanName() @@ -270,7 +348,9 @@ public function getDowngradePlanName() /** * Sets downgrade_plan_name + * * @param string $downgrade_plan_name + * * @return $this */ public function setDowngradePlanName($downgrade_plan_name) @@ -282,6 +362,7 @@ public function setDowngradePlanName($downgrade_plan_name) /** * Gets downgrade_request_status + * * @return string */ public function getDowngradeRequestStatus() @@ -291,7 +372,9 @@ public function getDowngradeRequestStatus() /** * Sets downgrade_request_status + * * @param string $downgrade_request_status + * * @return $this */ public function setDowngradeRequestStatus($downgrade_request_status) @@ -303,6 +386,7 @@ public function setDowngradeRequestStatus($downgrade_request_status) /** * Gets message + * * @return string */ public function getMessage() @@ -312,7 +396,9 @@ public function getMessage() /** * Sets message + * * @param string $message + * * @return $this */ public function setMessage($message) @@ -323,7 +409,9 @@ public function setMessage($message) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Draw.php b/src/Model/Draw.php index 41806a8d..33d90dfa 100644 --- a/src/Model/Draw.php +++ b/src/Model/Draw.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Draw Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Draw implements ArrayAccess +class Draw implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'draw'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -133,13 +136,115 @@ class Draw implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_signer_upload' => null, + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'locked' => null, + 'locked_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'use_background_as_canvas' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -222,9 +327,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -307,9 +412,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -392,34 +497,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -503,30 +637,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allow_signer_upload + * * @return string */ public function getAllowSignerUpload() @@ -536,7 +672,9 @@ public function getAllowSignerUpload() /** * Sets allow_signer_upload + * * @param string $allow_signer_upload + * * @return $this */ public function setAllowSignerUpload($allow_signer_upload) @@ -548,6 +686,7 @@ public function setAllowSignerUpload($allow_signer_upload) /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -557,7 +696,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -569,6 +710,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -578,7 +720,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -590,6 +734,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -599,7 +744,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -611,6 +758,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -620,7 +768,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -632,6 +782,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -641,7 +792,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -653,6 +806,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -662,7 +816,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -674,6 +830,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -683,7 +840,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -695,6 +854,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -704,7 +864,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -716,6 +878,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -725,7 +888,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -737,6 +902,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -746,7 +912,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -758,6 +926,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -767,7 +936,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -779,6 +950,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -788,7 +960,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -800,6 +974,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -809,7 +984,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -821,6 +998,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -830,7 +1008,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -842,6 +1022,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -851,7 +1032,9 @@ public function getAnchorUnits() /** * 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) @@ -863,6 +1046,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -872,7 +1056,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -884,6 +1070,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -893,7 +1080,9 @@ public function getAnchorXOffset() /** * 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) @@ -905,6 +1094,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -914,7 +1104,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -926,6 +1118,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -935,7 +1128,9 @@ public function getAnchorYOffset() /** * 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) @@ -947,6 +1142,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -956,7 +1152,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -968,6 +1166,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -977,7 +1176,9 @@ public function getConditionalParentLabel() /** * 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) @@ -989,6 +1190,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -998,7 +1200,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1010,6 +1214,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1019,7 +1224,9 @@ public function getConditionalParentValue() /** * 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) @@ -1031,6 +1238,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1040,7 +1248,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1052,6 +1262,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1061,7 +1272,9 @@ public function getCustomTabId() /** * 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) @@ -1073,6 +1286,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1082,7 +1296,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1094,6 +1310,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1103,7 +1320,9 @@ public function getDocumentId() /** * 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) @@ -1115,6 +1334,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1124,7 +1344,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1136,6 +1358,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1145,7 +1368,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1157,6 +1382,7 @@ public function setErrorDetails($error_details) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1166,7 +1392,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1178,6 +1406,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1187,7 +1416,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1199,6 +1430,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1208,7 +1440,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1220,6 +1454,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1229,7 +1464,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1241,6 +1478,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1250,7 +1488,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1262,6 +1502,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1271,7 +1512,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1283,6 +1526,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1292,7 +1536,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1304,6 +1550,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1313,7 +1560,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1325,6 +1574,7 @@ public function setHeightMetadata($height_metadata) /** * Gets locked + * * @return string */ public function getLocked() @@ -1334,7 +1584,9 @@ public function getLocked() /** * 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) @@ -1346,6 +1598,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1355,7 +1608,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1367,6 +1622,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1376,7 +1632,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1388,6 +1646,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1397,7 +1656,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1409,6 +1670,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1418,7 +1680,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1430,6 +1694,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1439,7 +1704,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1451,6 +1718,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1460,7 +1728,9 @@ public function getRecipientId() /** * 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) @@ -1472,6 +1742,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1481,7 +1752,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1493,6 +1766,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1502,7 +1776,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1514,6 +1790,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1523,7 +1800,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1535,6 +1814,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -1544,7 +1824,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -1556,6 +1838,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -1565,7 +1848,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -1577,6 +1862,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -1586,7 +1872,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1598,6 +1886,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -1607,7 +1896,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -1619,6 +1910,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1628,7 +1920,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1640,6 +1934,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1649,7 +1944,9 @@ public function getStatus() /** * 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) @@ -1661,6 +1958,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1670,7 +1968,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1682,6 +1982,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1691,7 +1992,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1703,6 +2006,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1712,7 +2016,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1724,6 +2030,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1733,7 +2040,9 @@ public function getTabId() /** * 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) @@ -1745,6 +2054,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1754,7 +2064,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1766,6 +2078,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1775,7 +2088,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1787,6 +2102,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1796,7 +2112,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1808,6 +2126,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1817,7 +2136,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -1829,6 +2150,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -1838,7 +2160,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -1850,6 +2174,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -1859,7 +2184,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -1871,6 +2198,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1880,7 +2208,9 @@ public function getTemplateLocked() /** * 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) @@ -1892,6 +2222,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -1901,7 +2232,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -1913,6 +2246,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1922,7 +2256,9 @@ public function getTemplateRequired() /** * 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) @@ -1934,6 +2270,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -1943,7 +2280,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -1955,6 +2294,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1964,7 +2304,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1976,6 +2318,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -1985,7 +2328,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -1997,6 +2342,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets use_background_as_canvas + * * @return string */ public function getUseBackgroundAsCanvas() @@ -2006,7 +2352,9 @@ public function getUseBackgroundAsCanvas() /** * Sets use_background_as_canvas + * * @param string $use_background_as_canvas + * * @return $this */ public function setUseBackgroundAsCanvas($use_background_as_canvas) @@ -2018,6 +2366,7 @@ public function setUseBackgroundAsCanvas($use_background_as_canvas) /** * Gets width + * * @return string */ public function getWidth() @@ -2027,7 +2376,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2039,6 +2390,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2048,7 +2400,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2060,6 +2414,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2069,7 +2424,9 @@ public function getXPosition() /** * 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) @@ -2081,6 +2438,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2090,7 +2448,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2102,6 +2462,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2111,7 +2472,9 @@ public function getYPosition() /** * 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) @@ -2123,6 +2486,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2132,7 +2496,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2143,7 +2509,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2153,7 +2521,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2163,8 +2533,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2178,7 +2550,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2188,16 +2562,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ENoteConfiguration.php b/src/Model/ENoteConfiguration.php index a444fac6..e48ce7a2 100644 --- a/src/Model/ENoteConfiguration.php +++ b/src/Model/ENoteConfiguration.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ENoteConfiguration Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ENoteConfiguration implements ArrayAccess +class ENoteConfiguration implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'eNoteConfiguration'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class ENoteConfiguration implements ArrayAccess 'user_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'connect_configured' => null, + 'e_note_configured' => null, + 'organization' => null, + 'password' => null, + 'user_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'user_name' => 'userName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'user_name' => 'setUserName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'user_name' => 'getUserName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets connect_configured + * * @return string */ public function getConnectConfigured() @@ -176,7 +240,9 @@ public function getConnectConfigured() /** * Sets connect_configured + * * @param string $connect_configured + * * @return $this */ public function setConnectConfigured($connect_configured) @@ -188,6 +254,7 @@ public function setConnectConfigured($connect_configured) /** * Gets e_note_configured + * * @return string */ public function getENoteConfigured() @@ -197,7 +264,9 @@ public function getENoteConfigured() /** * Sets e_note_configured + * * @param string $e_note_configured + * * @return $this */ public function setENoteConfigured($e_note_configured) @@ -209,6 +278,7 @@ public function setENoteConfigured($e_note_configured) /** * Gets organization + * * @return string */ public function getOrganization() @@ -218,7 +288,9 @@ public function getOrganization() /** * Sets organization + * * @param string $organization + * * @return $this */ public function setOrganization($organization) @@ -230,6 +302,7 @@ public function setOrganization($organization) /** * Gets password + * * @return string */ public function getPassword() @@ -239,7 +312,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -251,6 +326,7 @@ public function setPassword($password) /** * Gets user_name + * * @return string */ public function getUserName() @@ -260,7 +336,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -271,7 +349,9 @@ public function setUserName($user_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Editor.php b/src/Model/Editor.php index 40843823..a3b15264 100644 --- a/src/Model/Editor.php +++ b/src/Model/Editor.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Editor Class Doc Comment @@ -39,24 +40,28 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Editor implements ArrayAccess +class Editor implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'editor'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'access_code' => 'string', 'access_code_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'add_access_code_to_email' => 'string', + 'additional_notifications' => '\DocuSign\eSign\Model\RecipientAdditionalNotification[]', + 'additional_notifications_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'allow_system_override_for_locked_recipient' => 'string', 'client_user_id' => 'string', 'completed_count' => 'string', @@ -83,6 +88,7 @@ class Editor implements ArrayAccess 'id_check_configuration_name' => 'string', 'id_check_configuration_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'last_name' => 'string', 'last_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', @@ -122,19 +128,115 @@ class Editor implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'additional_notifications' => null, + 'additional_notifications_metadata' => null, + 'allow_system_override_for_locked_recipient' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email' => null, + 'email_metadata' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'first_name' => null, + 'first_name_metadata' => null, + 'full_name' => null, + 'full_name_metadata' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'last_name_metadata' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'name_metadata' => null, + 'note' => null, + 'note_metadata' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_id_metadata' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'access_code' => 'accessCode', 'access_code_metadata' => 'accessCodeMetadata', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'additional_notifications' => 'additionalNotifications', + 'additional_notifications_metadata' => 'additionalNotificationsMetadata', 'allow_system_override_for_locked_recipient' => 'allowSystemOverrideForLockedRecipient', 'client_user_id' => 'clientUserId', 'completed_count' => 'completedCount', @@ -161,6 +263,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_configuration_name_metadata' => 'idCheckConfigurationNameMetadata', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'last_name' => 'lastName', 'last_name_metadata' => 'lastNameMetadata', @@ -200,15 +303,17 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'access_code' => 'setAccessCode', 'access_code_metadata' => 'setAccessCodeMetadata', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'additional_notifications' => 'setAdditionalNotifications', + 'additional_notifications_metadata' => 'setAdditionalNotificationsMetadata', 'allow_system_override_for_locked_recipient' => 'setAllowSystemOverrideForLockedRecipient', 'client_user_id' => 'setClientUserId', 'completed_count' => 'setCompletedCount', @@ -235,6 +340,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'setIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'last_name' => 'setLastName', 'last_name_metadata' => 'setLastNameMetadata', @@ -274,15 +380,17 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'access_code' => 'getAccessCode', 'access_code_metadata' => 'getAccessCodeMetadata', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'additional_notifications' => 'getAdditionalNotifications', + 'additional_notifications_metadata' => 'getAdditionalNotificationsMetadata', 'allow_system_override_for_locked_recipient' => 'getAllowSystemOverrideForLockedRecipient', 'client_user_id' => 'getClientUserId', 'completed_count' => 'getCompletedCount', @@ -309,6 +417,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'getIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'last_name' => 'getLastName', 'last_name_metadata' => 'getLastNameMetadata', @@ -348,40 +457,71 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @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['access_code_metadata'] = isset($data['access_code_metadata']) ? $data['access_code_metadata'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['additional_notifications'] = isset($data['additional_notifications']) ? $data['additional_notifications'] : null; + $this->container['additional_notifications_metadata'] = isset($data['additional_notifications_metadata']) ? $data['additional_notifications_metadata'] : null; $this->container['allow_system_override_for_locked_recipient'] = isset($data['allow_system_override_for_locked_recipient']) ? $data['allow_system_override_for_locked_recipient'] : null; $this->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; $this->container['completed_count'] = isset($data['completed_count']) ? $data['completed_count'] : null; @@ -408,6 +548,7 @@ public function __construct(array $data = null) $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_configuration_name_metadata'] = isset($data['id_check_configuration_name_metadata']) ? $data['id_check_configuration_name_metadata'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['identity_verification'] = isset($data['identity_verification']) ? $data['identity_verification'] : 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['last_name_metadata'] = isset($data['last_name_metadata']) ? $data['last_name_metadata'] : null; @@ -448,30 +589,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -481,7 +624,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -493,6 +638,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -502,7 +648,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -514,6 +662,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -523,7 +672,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -533,8 +684,57 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets additional_notifications + * + * @return \DocuSign\eSign\Model\RecipientAdditionalNotification[] + */ + public function getAdditionalNotifications() + { + return $this->container['additional_notifications']; + } + + /** + * Sets additional_notifications + * + * @param \DocuSign\eSign\Model\RecipientAdditionalNotification[] $additional_notifications + * + * @return $this + */ + public function setAdditionalNotifications($additional_notifications) + { + $this->container['additional_notifications'] = $additional_notifications; + + return $this; + } + + /** + * Gets additional_notifications_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getAdditionalNotificationsMetadata() + { + return $this->container['additional_notifications_metadata']; + } + + /** + * Sets additional_notifications_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $additional_notifications_metadata additional_notifications_metadata + * + * @return $this + */ + public function setAdditionalNotificationsMetadata($additional_notifications_metadata) + { + $this->container['additional_notifications_metadata'] = $additional_notifications_metadata; + + return $this; + } + /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -544,7 +744,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -556,6 +758,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -565,7 +768,9 @@ public function getClientUserId() /** * 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) @@ -577,6 +782,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -586,7 +792,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -598,6 +806,7 @@ public function setCompletedCount($completed_count) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -607,7 +816,9 @@ public function getCustomFields() /** * 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) @@ -619,6 +830,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -628,7 +840,9 @@ public function getDeclinedDateTime() /** * 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) @@ -640,6 +854,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -649,7 +864,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -661,6 +878,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -670,7 +888,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -682,6 +902,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -691,7 +912,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -703,6 +926,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -712,7 +936,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -724,6 +950,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -733,7 +960,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -745,6 +974,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -754,7 +984,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -766,6 +998,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -775,7 +1008,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -787,6 +1022,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -796,7 +1032,9 @@ public function getEmail() /** * Sets email + * * @param string $email Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. + * * @return $this */ public function setEmail($email) @@ -808,6 +1046,7 @@ public function setEmail($email) /** * Gets email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailMetadata() @@ -817,7 +1056,9 @@ public function getEmailMetadata() /** * Sets email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata email_metadata + * * @return $this */ public function setEmailMetadata($email_metadata) @@ -829,6 +1070,7 @@ public function setEmailMetadata($email_metadata) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -838,7 +1080,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -850,6 +1094,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -859,7 +1104,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -871,6 +1118,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -880,7 +1128,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -892,6 +1142,7 @@ public function setErrorDetails($error_details) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -901,7 +1152,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -913,6 +1166,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -922,7 +1176,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -934,6 +1190,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -943,7 +1200,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -955,6 +1214,7 @@ public function setFirstName($first_name) /** * Gets first_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFirstNameMetadata() @@ -964,7 +1224,9 @@ public function getFirstNameMetadata() /** * Sets first_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata first_name_metadata + * * @return $this */ public function setFirstNameMetadata($first_name_metadata) @@ -976,6 +1238,7 @@ public function setFirstNameMetadata($first_name_metadata) /** * Gets full_name + * * @return string */ public function getFullName() @@ -985,7 +1248,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -997,6 +1262,7 @@ public function setFullName($full_name) /** * Gets full_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFullNameMetadata() @@ -1006,7 +1272,9 @@ public function getFullNameMetadata() /** * Sets full_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata full_name_metadata + * * @return $this */ public function setFullNameMetadata($full_name_metadata) @@ -1018,6 +1286,7 @@ public function setFullNameMetadata($full_name_metadata) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -1027,7 +1296,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -1039,6 +1310,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -1048,7 +1320,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -1060,6 +1334,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1069,7 +1344,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -1079,8 +1356,33 @@ public function setIdCheckInformationInput($id_check_information_input) return $this; } + /** + * Gets identity_verification + * + * @return \DocuSign\eSign\Model\RecipientIdentityVerification + */ + public function getIdentityVerification() + { + return $this->container['identity_verification']; + } + + /** + * Sets identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * + * @return $this + */ + public function setIdentityVerification($identity_verification) + { + $this->container['identity_verification'] = $identity_verification; + + return $this; + } + /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1090,7 +1392,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -1102,6 +1406,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -1111,7 +1416,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -1123,6 +1430,7 @@ public function setLastName($last_name) /** * Gets last_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLastNameMetadata() @@ -1132,7 +1440,9 @@ public function getLastNameMetadata() /** * Sets last_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata last_name_metadata + * * @return $this */ public function setLastNameMetadata($last_name_metadata) @@ -1144,6 +1454,7 @@ public function setLastNameMetadata($last_name_metadata) /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -1153,7 +1464,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -1165,6 +1478,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -1174,7 +1488,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -1186,6 +1502,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -1195,7 +1512,9 @@ public function getName() /** * Sets name + * * @param string $name legal name of the recipient. Maximum Length: 100 characters. + * * @return $this */ public function setName($name) @@ -1207,6 +1526,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1216,7 +1536,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1228,6 +1550,7 @@ public function setNameMetadata($name_metadata) /** * Gets note + * * @return string */ public function getNote() @@ -1237,7 +1560,9 @@ public function getNote() /** * 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) @@ -1249,6 +1574,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1258,7 +1584,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1270,6 +1598,7 @@ public function setNoteMetadata($note_metadata) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1279,7 +1608,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1291,6 +1622,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1300,7 +1632,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1312,6 +1646,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1321,7 +1656,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1333,6 +1670,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1342,7 +1680,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1354,6 +1694,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1363,7 +1704,9 @@ public function getRecipientId() /** * 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) @@ -1375,6 +1718,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1384,7 +1728,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1396,6 +1742,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1405,7 +1752,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1417,6 +1766,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1426,7 +1776,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1438,6 +1790,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1447,7 +1800,9 @@ public function getRequireIdLookup() /** * 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) @@ -1459,6 +1814,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1468,7 +1824,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1480,6 +1838,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1489,7 +1848,9 @@ public function getRoleName() /** * 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) @@ -1501,6 +1862,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1510,7 +1872,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -1522,6 +1886,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -1531,7 +1896,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -1543,6 +1910,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1552,7 +1920,9 @@ public function getSentDateTime() /** * 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) @@ -1564,6 +1934,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1573,7 +1944,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -1585,6 +1958,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1594,7 +1968,9 @@ public function getSigningGroupId() /** * 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) @@ -1606,6 +1982,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSigningGroupIdMetadata() @@ -1615,7 +1992,9 @@ public function getSigningGroupIdMetadata() /** * Sets signing_group_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata signing_group_id_metadata + * * @return $this */ public function setSigningGroupIdMetadata($signing_group_id_metadata) @@ -1627,6 +2006,7 @@ public function setSigningGroupIdMetadata($signing_group_id_metadata) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1636,7 +2016,9 @@ public function getSigningGroupName() /** * 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) @@ -1648,6 +2030,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1657,7 +2040,9 @@ public function getSigningGroupUsers() /** * 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) @@ -1669,6 +2054,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1678,7 +2064,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -1690,6 +2078,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1699,7 +2088,9 @@ public function getSocialAuthentications() /** * 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) @@ -1711,6 +2102,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1720,7 +2112,9 @@ public function getStatus() /** * 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) @@ -1732,6 +2126,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -1741,7 +2136,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -1753,6 +2150,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -1762,7 +2160,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -1774,6 +2174,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1783,7 +2184,9 @@ public function getTemplateLocked() /** * 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) @@ -1795,6 +2198,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1804,7 +2208,9 @@ public function getTemplateRequired() /** * 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) @@ -1816,6 +2222,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1825,7 +2232,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1837,6 +2246,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1846,7 +2256,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1857,7 +2269,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1867,7 +2281,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1877,8 +2293,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1892,7 +2310,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1902,16 +2322,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Email.php b/src/Model/Email.php index 104a50c5..f053e231 100644 --- a/src/Model/Email.php +++ b/src/Model/Email.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Email Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Email implements ArrayAccess +class Email implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'email'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -167,13 +170,149 @@ class Email implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conceal_value_on_document' => null, + 'conceal_value_on_document_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'disable_auto_size' => null, + 'disable_auto_size_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'max_length' => null, + 'max_length_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'original_value' => null, + 'original_value_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'require_all' => null, + 'require_all_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'sender_required' => null, + 'sender_required_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'validation_message' => null, + 'validation_message_metadata' => null, + 'validation_pattern' => null, + 'validation_pattern_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -290,9 +429,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -409,9 +548,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -528,34 +667,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -673,30 +841,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -706,7 +876,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -718,6 +890,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -727,7 +900,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -739,6 +914,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -748,7 +924,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -760,6 +938,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -769,7 +948,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -781,6 +962,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -790,7 +972,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -802,6 +986,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -811,7 +996,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -823,6 +1010,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -832,7 +1020,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -844,6 +1034,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -853,7 +1044,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -865,6 +1058,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -874,7 +1068,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -886,6 +1082,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -895,7 +1092,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -907,6 +1106,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -916,7 +1116,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -928,6 +1130,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -937,7 +1140,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -949,6 +1154,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -958,7 +1164,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -970,6 +1178,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -979,7 +1188,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -991,6 +1202,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -1000,7 +1212,9 @@ public function getAnchorUnits() /** * 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) @@ -1012,6 +1226,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -1021,7 +1236,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -1033,6 +1250,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -1042,7 +1260,9 @@ public function getAnchorXOffset() /** * 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) @@ -1054,6 +1274,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1063,7 +1284,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1075,6 +1298,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1084,7 +1308,9 @@ public function getAnchorYOffset() /** * 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) @@ -1096,6 +1322,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1105,7 +1332,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1117,6 +1346,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1126,7 +1356,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1138,6 +1370,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1147,7 +1380,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1159,6 +1394,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -1168,7 +1404,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -1180,6 +1418,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conceal_value_on_document_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConcealValueOnDocumentMetadata() @@ -1189,7 +1428,9 @@ public function getConcealValueOnDocumentMetadata() /** * Sets conceal_value_on_document_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata conceal_value_on_document_metadata + * * @return $this */ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_metadata) @@ -1201,6 +1442,7 @@ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_met /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1210,7 +1452,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1222,6 +1466,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1231,7 +1476,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1243,6 +1490,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1252,7 +1500,9 @@ public function getConditionalParentValue() /** * 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) @@ -1264,6 +1514,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1273,7 +1524,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1285,6 +1538,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1294,7 +1548,9 @@ public function getCustomTabId() /** * 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) @@ -1306,6 +1562,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1315,7 +1572,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1327,6 +1586,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -1336,7 +1596,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -1348,6 +1610,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets disable_auto_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisableAutoSizeMetadata() @@ -1357,7 +1620,9 @@ public function getDisableAutoSizeMetadata() /** * Sets disable_auto_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata disable_auto_size_metadata + * * @return $this */ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) @@ -1369,6 +1634,7 @@ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1378,7 +1644,9 @@ public function getDocumentId() /** * 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) @@ -1390,6 +1658,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1399,7 +1668,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1411,6 +1682,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1420,7 +1692,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1432,6 +1706,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1441,7 +1716,9 @@ public function getFont() /** * 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) @@ -1453,6 +1730,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1462,7 +1740,9 @@ public function getFontColor() /** * 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) @@ -1474,6 +1754,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1483,7 +1764,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1495,6 +1778,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1504,7 +1788,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1516,6 +1802,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1525,7 +1812,9 @@ public function getFontSize() /** * 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) @@ -1537,6 +1826,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1546,7 +1836,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1558,6 +1850,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1567,7 +1860,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1579,6 +1874,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1588,7 +1884,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1600,6 +1898,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1609,7 +1908,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1621,6 +1922,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1630,7 +1932,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1642,6 +1946,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1651,7 +1956,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1663,6 +1970,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1672,7 +1980,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1684,6 +1994,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1693,7 +2004,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1705,6 +2018,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1714,7 +2028,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1726,6 +2042,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1735,7 +2052,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1747,6 +2066,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1756,7 +2076,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1768,6 +2090,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1777,7 +2100,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1789,6 +2114,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1798,7 +2124,9 @@ public function getLocked() /** * 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) @@ -1810,6 +2138,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1819,7 +2148,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1831,6 +2162,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets max_length + * * @return string */ public function getMaxLength() @@ -1840,7 +2172,9 @@ public function getMaxLength() /** * Sets max_length + * * @param string $max_length An optional value that describes the maximum length of the property when the property is a string. + * * @return $this */ public function setMaxLength($max_length) @@ -1852,6 +2186,7 @@ public function setMaxLength($max_length) /** * Gets max_length_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaxLengthMetadata() @@ -1861,7 +2196,9 @@ public function getMaxLengthMetadata() /** * Sets max_length_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata max_length_metadata + * * @return $this */ public function setMaxLengthMetadata($max_length_metadata) @@ -1873,6 +2210,7 @@ public function setMaxLengthMetadata($max_length_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1882,7 +2220,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1894,6 +2234,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1903,7 +2244,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1915,6 +2258,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1924,7 +2268,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1936,6 +2282,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1945,7 +2292,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1957,6 +2306,7 @@ public function setNameMetadata($name_metadata) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -1966,7 +2316,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -1978,6 +2330,7 @@ public function setOriginalValue($original_value) /** * Gets original_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOriginalValueMetadata() @@ -1987,7 +2340,9 @@ public function getOriginalValueMetadata() /** * Sets original_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata original_value_metadata + * * @return $this */ public function setOriginalValueMetadata($original_value_metadata) @@ -1999,6 +2354,7 @@ public function setOriginalValueMetadata($original_value_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -2008,7 +2364,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -2020,6 +2378,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -2029,7 +2388,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -2041,6 +2402,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -2050,7 +2412,9 @@ public function getRecipientId() /** * 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) @@ -2062,6 +2426,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -2071,7 +2436,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -2083,6 +2450,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -2092,7 +2460,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -2104,6 +2474,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -2113,7 +2484,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -2125,6 +2498,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -2134,7 +2508,9 @@ public function getRequireAll() /** * 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) @@ -2146,6 +2522,7 @@ public function setRequireAll($require_all) /** * Gets require_all_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireAllMetadata() @@ -2155,7 +2532,9 @@ public function getRequireAllMetadata() /** * Sets require_all_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata require_all_metadata + * * @return $this */ public function setRequireAllMetadata($require_all_metadata) @@ -2167,6 +2546,7 @@ public function setRequireAllMetadata($require_all_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -2176,7 +2556,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -2188,6 +2570,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -2197,7 +2580,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2209,6 +2594,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -2218,7 +2604,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -2230,6 +2618,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -2239,7 +2628,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -2251,6 +2642,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -2260,7 +2652,9 @@ public function getSenderRequired() /** * 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. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + * * @return $this */ public function setSenderRequired($sender_required) @@ -2272,6 +2666,7 @@ public function setSenderRequired($sender_required) /** * Gets sender_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderRequiredMetadata() @@ -2281,7 +2676,9 @@ public function getSenderRequiredMetadata() /** * Sets sender_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata sender_required_metadata + * * @return $this */ public function setSenderRequiredMetadata($sender_required_metadata) @@ -2293,6 +2690,7 @@ public function setSenderRequiredMetadata($sender_required_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -2302,7 +2700,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -2314,6 +2714,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -2323,7 +2724,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -2335,6 +2738,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2344,7 +2748,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2356,6 +2762,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2365,7 +2772,9 @@ public function getStatus() /** * 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) @@ -2377,6 +2786,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2386,7 +2796,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2398,6 +2810,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2407,7 +2820,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2419,6 +2834,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2428,7 +2844,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2440,6 +2858,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2449,7 +2868,9 @@ public function getTabId() /** * 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) @@ -2461,6 +2882,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2470,7 +2892,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2482,6 +2906,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2491,7 +2916,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2503,6 +2930,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2512,7 +2940,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2524,6 +2954,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2533,7 +2964,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2545,6 +2978,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2554,7 +2988,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2566,6 +3002,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2575,7 +3012,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2587,6 +3026,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2596,7 +3036,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2608,6 +3050,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2617,7 +3060,9 @@ public function getTemplateLocked() /** * 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) @@ -2629,6 +3074,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2638,7 +3084,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2650,6 +3098,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2659,7 +3108,9 @@ public function getTemplateRequired() /** * 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) @@ -2671,6 +3122,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2680,7 +3132,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2692,6 +3146,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2701,7 +3156,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2713,6 +3170,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2722,7 +3180,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2734,6 +3194,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2743,7 +3204,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2755,6 +3218,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2764,7 +3228,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2776,6 +3242,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -2785,7 +3252,9 @@ public function getValidationMessage() /** * Sets validation_message + * * @param string $validation_message The message displayed if the custom tab fails input validation (either custom of embedded). + * * @return $this */ public function setValidationMessage($validation_message) @@ -2797,6 +3266,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_message_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationMessageMetadata() @@ -2806,7 +3276,9 @@ public function getValidationMessageMetadata() /** * Sets validation_message_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata validation_message_metadata + * * @return $this */ public function setValidationMessageMetadata($validation_message_metadata) @@ -2818,6 +3290,7 @@ public function setValidationMessageMetadata($validation_message_metadata) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -2827,7 +3300,9 @@ public function getValidationPattern() /** * Sets validation_pattern + * * @param string $validation_pattern A regular expression used to validate input for the tab. + * * @return $this */ public function setValidationPattern($validation_pattern) @@ -2839,6 +3314,7 @@ public function setValidationPattern($validation_pattern) /** * Gets validation_pattern_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationPatternMetadata() @@ -2848,7 +3324,9 @@ public function getValidationPatternMetadata() /** * Sets validation_pattern_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata validation_pattern_metadata + * * @return $this */ public function setValidationPatternMetadata($validation_pattern_metadata) @@ -2860,6 +3338,7 @@ public function setValidationPatternMetadata($validation_pattern_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2869,7 +3348,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2881,6 +3362,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2890,7 +3372,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2902,6 +3386,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2911,7 +3396,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2923,6 +3410,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2932,7 +3420,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2944,6 +3434,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2953,7 +3444,9 @@ public function getXPosition() /** * 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) @@ -2965,6 +3458,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2974,7 +3468,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2986,6 +3482,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2995,7 +3492,9 @@ public function getYPosition() /** * 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) @@ -3007,6 +3506,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -3016,7 +3516,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -3027,7 +3529,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -3037,7 +3541,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -3047,8 +3553,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -3062,7 +3570,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -3072,16 +3582,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EmailAddress.php b/src/Model/EmailAddress.php index aca9f523..268d550f 100644 --- a/src/Model/EmailAddress.php +++ b/src/Model/EmailAddress.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EmailAddress Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EmailAddress implements ArrayAccess +class EmailAddress implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'emailAddress'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -143,13 +146,125 @@ class EmailAddress implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -242,9 +357,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -337,9 +452,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -432,34 +547,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -553,30 +697,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -586,7 +732,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -598,6 +746,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -607,7 +756,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -619,6 +770,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -628,7 +780,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -640,6 +794,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -649,7 +804,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -661,6 +818,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -670,7 +828,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -682,6 +842,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -691,7 +852,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -703,6 +866,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -712,7 +876,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -724,6 +890,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -733,7 +900,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -745,6 +914,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -754,7 +924,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -766,6 +938,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -775,7 +948,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -787,6 +962,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -796,7 +972,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -808,6 +986,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -817,7 +996,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -829,6 +1010,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -838,7 +1020,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -850,6 +1034,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -859,7 +1044,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -871,6 +1058,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -880,7 +1068,9 @@ public function getAnchorUnits() /** * 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) @@ -892,6 +1082,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -901,7 +1092,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -913,6 +1106,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -922,7 +1116,9 @@ public function getAnchorXOffset() /** * 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) @@ -934,6 +1130,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -943,7 +1140,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -955,6 +1154,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -964,7 +1164,9 @@ public function getAnchorYOffset() /** * 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) @@ -976,6 +1178,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -985,7 +1188,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -997,6 +1202,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1006,7 +1212,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1018,6 +1226,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1027,7 +1236,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1039,6 +1250,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1048,7 +1260,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1060,6 +1274,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1069,7 +1284,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1081,6 +1298,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1090,7 +1308,9 @@ public function getConditionalParentValue() /** * 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) @@ -1102,6 +1322,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1111,7 +1332,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1123,6 +1346,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1132,7 +1356,9 @@ public function getCustomTabId() /** * 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) @@ -1144,6 +1370,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1153,7 +1380,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1165,6 +1394,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1174,7 +1404,9 @@ public function getDocumentId() /** * 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) @@ -1186,6 +1418,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1195,7 +1428,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1207,6 +1442,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1216,7 +1452,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1228,6 +1466,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1237,7 +1476,9 @@ public function getFont() /** * 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) @@ -1249,6 +1490,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1258,7 +1500,9 @@ public function getFontColor() /** * 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) @@ -1270,6 +1514,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1279,7 +1524,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1291,6 +1538,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1300,7 +1548,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1312,6 +1562,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1321,7 +1572,9 @@ public function getFontSize() /** * 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) @@ -1333,6 +1586,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1342,7 +1596,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1354,6 +1610,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1363,7 +1620,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1375,6 +1634,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1384,7 +1644,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1396,6 +1658,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1405,7 +1668,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1417,6 +1682,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1426,7 +1692,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1438,6 +1706,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1447,7 +1716,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1459,6 +1730,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1468,7 +1740,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1480,6 +1754,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1489,7 +1764,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1501,6 +1778,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1510,7 +1788,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1522,6 +1802,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1531,7 +1812,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1543,6 +1826,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1552,7 +1836,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1564,6 +1850,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1573,7 +1860,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1585,6 +1874,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1594,7 +1884,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1606,6 +1898,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1615,7 +1908,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1627,6 +1922,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1636,7 +1932,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1648,6 +1946,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1657,7 +1956,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1669,6 +1970,7 @@ public function setNameMetadata($name_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1678,7 +1980,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1690,6 +1994,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1699,7 +2004,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1711,6 +2018,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1720,7 +2028,9 @@ public function getRecipientId() /** * 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) @@ -1732,6 +2042,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1741,7 +2052,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1753,6 +2066,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1762,7 +2076,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1774,6 +2090,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1783,7 +2100,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1795,6 +2114,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1804,7 +2124,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1816,6 +2138,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1825,7 +2148,9 @@ public function getStatus() /** * 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) @@ -1837,6 +2162,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1846,7 +2172,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1858,6 +2186,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1867,7 +2196,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1879,6 +2210,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1888,7 +2220,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1900,6 +2234,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1909,7 +2244,9 @@ public function getTabId() /** * 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) @@ -1921,6 +2258,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1930,7 +2268,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1942,6 +2282,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1951,7 +2292,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1963,6 +2306,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1972,7 +2316,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1984,6 +2330,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1993,7 +2340,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2005,6 +2354,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2014,7 +2364,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2026,6 +2378,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2035,7 +2388,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2047,6 +2402,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2056,7 +2412,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2068,6 +2426,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2077,7 +2436,9 @@ public function getTemplateLocked() /** * 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) @@ -2089,6 +2450,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2098,7 +2460,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2110,6 +2474,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2119,7 +2484,9 @@ public function getTemplateRequired() /** * 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) @@ -2131,6 +2498,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2140,7 +2508,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2152,6 +2522,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2161,7 +2532,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2173,6 +2546,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2182,7 +2556,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2194,6 +2570,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2203,7 +2580,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2215,6 +2594,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2224,7 +2604,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2236,6 +2618,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2245,7 +2628,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2257,6 +2642,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2266,7 +2652,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2278,6 +2666,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2287,7 +2676,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2299,6 +2690,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2308,7 +2700,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2320,6 +2714,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2329,7 +2724,9 @@ public function getXPosition() /** * 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) @@ -2341,6 +2738,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2350,7 +2748,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2362,6 +2762,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2371,7 +2772,9 @@ public function getYPosition() /** * 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) @@ -2383,6 +2786,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2392,7 +2796,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2403,7 +2809,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2413,7 +2821,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2423,8 +2833,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2438,7 +2850,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2448,16 +2862,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EmailSettings.php b/src/Model/EmailSettings.php index 3a267b6a..4ca0f8c6 100644 --- a/src/Model/EmailSettings.php +++ b/src/Model/EmailSettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EmailSettings Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EmailSettings implements ArrayAccess +class EmailSettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'emailSettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class EmailSettings implements ArrayAccess 'reply_email_name_override' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bcc_email_addresses' => null, + 'reply_email_address_override' => null, + 'reply_email_name_override' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'reply_email_name_override' => 'replyEmailNameOverride' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'reply_email_name_override' => 'setReplyEmailNameOverride' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'reply_email_name_override' => 'getReplyEmailNameOverride' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bcc_email_addresses + * * @return \DocuSign\eSign\Model\BccEmailAddress[] */ public function getBccEmailAddresses() @@ -167,7 +229,9 @@ public function getBccEmailAddresses() /** * Sets bcc_email_addresses + * * @param \DocuSign\eSign\Model\BccEmailAddress[] $bcc_email_addresses A list of email addresses that receive a copy of all email communications for an envelope. You can use this for archiving purposes. + * * @return $this */ public function setBccEmailAddresses($bcc_email_addresses) @@ -179,6 +243,7 @@ public function setBccEmailAddresses($bcc_email_addresses) /** * Gets reply_email_address_override + * * @return string */ public function getReplyEmailAddressOverride() @@ -188,7 +253,9 @@ public function getReplyEmailAddressOverride() /** * Sets reply_email_address_override + * * @param string $reply_email_address_override + * * @return $this */ public function setReplyEmailAddressOverride($reply_email_address_override) @@ -200,6 +267,7 @@ public function setReplyEmailAddressOverride($reply_email_address_override) /** * Gets reply_email_name_override + * * @return string */ public function getReplyEmailNameOverride() @@ -209,7 +277,9 @@ public function getReplyEmailNameOverride() /** * Sets reply_email_name_override + * * @param string $reply_email_name_override + * * @return $this */ public function setReplyEmailNameOverride($reply_email_name_override) @@ -220,7 +290,9 @@ public function setReplyEmailNameOverride($reply_email_name_override) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Envelope.php b/src/Model/Envelope.php index a4b136d6..13555746 100644 --- a/src/Model/Envelope.php +++ b/src/Model/Envelope.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Envelope Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Envelope implements ArrayAccess +class Envelope implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelope'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -131,13 +134,113 @@ class Envelope implements ArrayAccess 'voided_reason' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_control_list_base64' => null, + 'allow_comments' => null, + 'allow_markup' => null, + 'allow_reassign' => null, + 'allow_view_history' => null, + 'any_signer' => null, + 'asynchronous' => null, + 'attachments_uri' => null, + 'authoritative_copy' => null, + 'authoritative_copy_default' => null, + 'auto_navigation' => null, + 'brand_id' => null, + 'brand_lock' => null, + 'certificate_uri' => null, + 'completed_date_time' => null, + 'copy_recipient_data' => null, + 'created_date_time' => null, + 'custom_fields' => null, + 'custom_fields_uri' => null, + 'declined_date_time' => null, + 'deleted_date_time' => null, + 'delivered_date_time' => null, + 'disable_responsive_document' => null, + 'documents_combined_uri' => null, + 'documents_uri' => null, + 'email_blurb' => null, + 'email_settings' => null, + 'email_subject' => null, + 'enable_wet_sign' => null, + 'enforce_signer_visibility' => null, + 'envelope_attachments' => null, + 'envelope_documents' => null, + 'envelope_id' => null, + 'envelope_id_stamping' => null, + 'envelope_location' => null, + 'envelope_metadata' => null, + 'envelope_uri' => null, + 'expire_after' => null, + 'expire_date_time' => null, + 'expire_enabled' => null, + 'external_envelope_id' => null, + 'folders' => null, + 'has_comments' => null, + 'has_form_data_changed' => null, + 'has_wav_file' => null, + 'holder' => null, + 'initial_sent_date_time' => null, + 'is21_cfr_part11' => null, + 'is_dynamic_envelope' => null, + 'is_signature_provider_envelope' => null, + 'last_modified_date_time' => null, + 'location' => null, + 'lock_information' => null, + 'message_lock' => null, + 'notification' => null, + 'notification_uri' => null, + 'power_form' => null, + 'purge_completed_date' => null, + 'purge_request_date' => null, + 'purge_state' => null, + 'recipients' => null, + 'recipients_lock' => null, + 'recipients_uri' => null, + 'sender' => null, + 'sent_date_time' => null, + 'signer_can_sign_on_mobile' => null, + 'signing_location' => null, + 'status' => null, + 'status_changed_date_time' => null, + 'status_date_time' => null, + 'templates_uri' => null, + 'transaction_id' => null, + 'use_disclosure' => null, + 'voided_date_time' => null, + 'voided_reason' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -218,9 +321,9 @@ public static function swaggerTypes() 'voided_reason' => 'voidedReason' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -301,9 +404,9 @@ public static function swaggerTypes() 'voided_reason' => 'setVoidedReason' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -384,34 +487,63 @@ public static function swaggerTypes() 'voided_reason' => 'getVoidedReason' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -493,30 +625,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_control_list_base64 + * * @return string */ public function getAccessControlListBase64() @@ -526,7 +660,9 @@ public function getAccessControlListBase64() /** * Sets access_control_list_base64 + * * @param string $access_control_list_base64 + * * @return $this */ public function setAccessControlListBase64($access_control_list_base64) @@ -538,6 +674,7 @@ public function setAccessControlListBase64($access_control_list_base64) /** * Gets allow_comments + * * @return string */ public function getAllowComments() @@ -547,7 +684,9 @@ public function getAllowComments() /** * Sets allow_comments + * * @param string $allow_comments + * * @return $this */ public function setAllowComments($allow_comments) @@ -559,6 +698,7 @@ public function setAllowComments($allow_comments) /** * Gets allow_markup + * * @return string */ public function getAllowMarkup() @@ -568,7 +708,9 @@ public function getAllowMarkup() /** * Sets allow_markup + * * @param string $allow_markup When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this + * * @return $this */ public function setAllowMarkup($allow_markup) @@ -580,6 +722,7 @@ public function setAllowMarkup($allow_markup) /** * Gets allow_reassign + * * @return string */ public function getAllowReassign() @@ -589,7 +732,9 @@ public function getAllowReassign() /** * Sets allow_reassign + * * @param string $allow_reassign When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. + * * @return $this */ public function setAllowReassign($allow_reassign) @@ -601,6 +746,7 @@ public function setAllowReassign($allow_reassign) /** * Gets allow_view_history + * * @return string */ public function getAllowViewHistory() @@ -610,7 +756,9 @@ public function getAllowViewHistory() /** * Sets allow_view_history + * * @param string $allow_view_history + * * @return $this */ public function setAllowViewHistory($allow_view_history) @@ -622,6 +770,7 @@ public function setAllowViewHistory($allow_view_history) /** * Gets any_signer + * * @return string */ public function getAnySigner() @@ -631,7 +780,9 @@ public function getAnySigner() /** * Sets any_signer + * * @param string $any_signer + * * @return $this */ public function setAnySigner($any_signer) @@ -643,6 +794,7 @@ public function setAnySigner($any_signer) /** * Gets asynchronous + * * @return string */ public function getAsynchronous() @@ -652,7 +804,9 @@ public function getAsynchronous() /** * Sets asynchronous + * * @param string $asynchronous When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. + * * @return $this */ public function setAsynchronous($asynchronous) @@ -664,6 +818,7 @@ public function setAsynchronous($asynchronous) /** * Gets attachments_uri + * * @return string */ public function getAttachmentsUri() @@ -673,7 +828,9 @@ public function getAttachmentsUri() /** * Sets attachments_uri + * * @param string $attachments_uri + * * @return $this */ public function setAttachmentsUri($attachments_uri) @@ -685,6 +842,7 @@ public function setAttachmentsUri($attachments_uri) /** * Gets authoritative_copy + * * @return string */ public function getAuthoritativeCopy() @@ -694,7 +852,9 @@ public function getAuthoritativeCopy() /** * 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) @@ -706,6 +866,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets authoritative_copy_default + * * @return string */ public function getAuthoritativeCopyDefault() @@ -715,7 +876,9 @@ public function getAuthoritativeCopyDefault() /** * Sets authoritative_copy_default + * * @param string $authoritative_copy_default + * * @return $this */ public function setAuthoritativeCopyDefault($authoritative_copy_default) @@ -727,6 +890,7 @@ public function setAuthoritativeCopyDefault($authoritative_copy_default) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -736,7 +900,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -748,6 +914,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -757,7 +924,9 @@ public function getBrandId() /** * Sets brand_id + * * @param string $brand_id + * * @return $this */ public function setBrandId($brand_id) @@ -769,6 +938,7 @@ public function setBrandId($brand_id) /** * Gets brand_lock + * * @return string */ public function getBrandLock() @@ -778,7 +948,9 @@ public function getBrandLock() /** * Sets brand_lock + * * @param string $brand_lock + * * @return $this */ public function setBrandLock($brand_lock) @@ -790,6 +962,7 @@ public function setBrandLock($brand_lock) /** * Gets certificate_uri + * * @return string */ public function getCertificateUri() @@ -799,7 +972,9 @@ public function getCertificateUri() /** * Sets certificate_uri + * * @param string $certificate_uri Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. + * * @return $this */ public function setCertificateUri($certificate_uri) @@ -811,6 +986,7 @@ public function setCertificateUri($certificate_uri) /** * Gets completed_date_time + * * @return string */ public function getCompletedDateTime() @@ -820,7 +996,9 @@ public function getCompletedDateTime() /** * Sets completed_date_time + * * @param string $completed_date_time Specifies the date and time this item was completed. + * * @return $this */ public function setCompletedDateTime($completed_date_time) @@ -832,6 +1010,7 @@ public function setCompletedDateTime($completed_date_time) /** * Gets copy_recipient_data + * * @return string */ public function getCopyRecipientData() @@ -841,7 +1020,9 @@ public function getCopyRecipientData() /** * Sets copy_recipient_data + * * @param string $copy_recipient_data + * * @return $this */ public function setCopyRecipientData($copy_recipient_data) @@ -853,6 +1034,7 @@ public function setCopyRecipientData($copy_recipient_data) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -862,7 +1044,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -874,6 +1058,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\CustomFields */ public function getCustomFields() @@ -883,7 +1068,9 @@ public function getCustomFields() /** * Sets custom_fields - * @param \DocuSign\eSign\Model\CustomFields $custom_fields + * + * @param \DocuSign\eSign\Model\CustomFields $custom_fields custom_fields + * * @return $this */ public function setCustomFields($custom_fields) @@ -895,6 +1082,7 @@ public function setCustomFields($custom_fields) /** * Gets custom_fields_uri + * * @return string */ public function getCustomFieldsUri() @@ -904,7 +1092,9 @@ public function getCustomFieldsUri() /** * Sets custom_fields_uri + * * @param string $custom_fields_uri Contains a URI for an endpoint that you can use to retrieve the custom fields. + * * @return $this */ public function setCustomFieldsUri($custom_fields_uri) @@ -916,6 +1106,7 @@ public function setCustomFieldsUri($custom_fields_uri) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -925,7 +1116,9 @@ public function getDeclinedDateTime() /** * 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) @@ -937,6 +1130,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets deleted_date_time + * * @return string */ public function getDeletedDateTime() @@ -946,7 +1140,9 @@ public function getDeletedDateTime() /** * Sets deleted_date_time + * * @param string $deleted_date_time Specifies the data and time the item was deleted. + * * @return $this */ public function setDeletedDateTime($deleted_date_time) @@ -958,6 +1154,7 @@ public function setDeletedDateTime($deleted_date_time) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -967,7 +1164,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -979,6 +1178,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets disable_responsive_document + * * @return string */ public function getDisableResponsiveDocument() @@ -988,7 +1188,9 @@ public function getDisableResponsiveDocument() /** * Sets disable_responsive_document + * * @param string $disable_responsive_document + * * @return $this */ public function setDisableResponsiveDocument($disable_responsive_document) @@ -1000,6 +1202,7 @@ public function setDisableResponsiveDocument($disable_responsive_document) /** * Gets documents_combined_uri + * * @return string */ public function getDocumentsCombinedUri() @@ -1009,7 +1212,9 @@ public function getDocumentsCombinedUri() /** * Sets documents_combined_uri + * * @param string $documents_combined_uri + * * @return $this */ public function setDocumentsCombinedUri($documents_combined_uri) @@ -1021,6 +1226,7 @@ public function setDocumentsCombinedUri($documents_combined_uri) /** * Gets documents_uri + * * @return string */ public function getDocumentsUri() @@ -1030,7 +1236,9 @@ public function getDocumentsUri() /** * Sets documents_uri + * * @param string $documents_uri Contains a URI for an endpoint that you can use to retrieve the documents. + * * @return $this */ public function setDocumentsUri($documents_uri) @@ -1042,6 +1250,7 @@ public function setDocumentsUri($documents_uri) /** * Gets email_blurb + * * @return string */ public function getEmailBlurb() @@ -1051,7 +1260,9 @@ public function getEmailBlurb() /** * Sets email_blurb + * * @param string $email_blurb This is the same as the email body. If specified it is included in email body for all envelope recipients. + * * @return $this */ public function setEmailBlurb($email_blurb) @@ -1063,6 +1274,7 @@ public function setEmailBlurb($email_blurb) /** * Gets email_settings + * * @return \DocuSign\eSign\Model\EmailSettings */ public function getEmailSettings() @@ -1072,7 +1284,9 @@ public function getEmailSettings() /** * Sets email_settings - * @param \DocuSign\eSign\Model\EmailSettings $email_settings + * + * @param \DocuSign\eSign\Model\EmailSettings $email_settings email_settings + * * @return $this */ public function setEmailSettings($email_settings) @@ -1084,6 +1298,7 @@ public function setEmailSettings($email_settings) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -1093,7 +1308,9 @@ public function getEmailSubject() /** * Sets email_subject + * * @param string $email_subject Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. + * * @return $this */ public function setEmailSubject($email_subject) @@ -1105,6 +1322,7 @@ public function setEmailSubject($email_subject) /** * Gets enable_wet_sign + * * @return string */ public function getEnableWetSign() @@ -1114,7 +1332,9 @@ public function getEnableWetSign() /** * Sets enable_wet_sign + * * @param string $enable_wet_sign When set to **true**, the signer is allowed to print the document and sign it on paper. + * * @return $this */ public function setEnableWetSign($enable_wet_sign) @@ -1126,6 +1346,7 @@ public function setEnableWetSign($enable_wet_sign) /** * Gets enforce_signer_visibility + * * @return string */ public function getEnforceSignerVisibility() @@ -1135,7 +1356,9 @@ public function getEnforceSignerVisibility() /** * Sets enforce_signer_visibility + * * @param string $enforce_signer_visibility When set to **true**, 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. Your account must have Document Visibility enabled to use this. + * * @return $this */ public function setEnforceSignerVisibility($enforce_signer_visibility) @@ -1147,6 +1370,7 @@ public function setEnforceSignerVisibility($enforce_signer_visibility) /** * Gets envelope_attachments + * * @return \DocuSign\eSign\Model\Attachment[] */ public function getEnvelopeAttachments() @@ -1156,7 +1380,9 @@ public function getEnvelopeAttachments() /** * Sets envelope_attachments + * * @param \DocuSign\eSign\Model\Attachment[] $envelope_attachments + * * @return $this */ public function setEnvelopeAttachments($envelope_attachments) @@ -1168,6 +1394,7 @@ public function setEnvelopeAttachments($envelope_attachments) /** * Gets envelope_documents + * * @return \DocuSign\eSign\Model\EnvelopeDocument[] */ public function getEnvelopeDocuments() @@ -1177,7 +1404,9 @@ public function getEnvelopeDocuments() /** * Sets envelope_documents + * * @param \DocuSign\eSign\Model\EnvelopeDocument[] $envelope_documents + * * @return $this */ public function setEnvelopeDocuments($envelope_documents) @@ -1189,6 +1418,7 @@ public function setEnvelopeDocuments($envelope_documents) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -1198,7 +1428,9 @@ public function getEnvelopeId() /** * 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) @@ -1210,6 +1442,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_id_stamping + * * @return string */ public function getEnvelopeIdStamping() @@ -1219,7 +1452,9 @@ public function getEnvelopeIdStamping() /** * Sets envelope_id_stamping + * * @param string $envelope_id_stamping When set to **true**, Envelope ID Stamping is enabled. + * * @return $this */ public function setEnvelopeIdStamping($envelope_id_stamping) @@ -1231,6 +1466,7 @@ public function setEnvelopeIdStamping($envelope_id_stamping) /** * Gets envelope_location + * * @return string */ public function getEnvelopeLocation() @@ -1240,7 +1476,9 @@ public function getEnvelopeLocation() /** * Sets envelope_location + * * @param string $envelope_location + * * @return $this */ public function setEnvelopeLocation($envelope_location) @@ -1252,6 +1490,7 @@ public function setEnvelopeLocation($envelope_location) /** * Gets envelope_metadata + * * @return \DocuSign\eSign\Model\EnvelopeMetadata */ public function getEnvelopeMetadata() @@ -1261,7 +1500,9 @@ public function getEnvelopeMetadata() /** * Sets envelope_metadata - * @param \DocuSign\eSign\Model\EnvelopeMetadata $envelope_metadata + * + * @param \DocuSign\eSign\Model\EnvelopeMetadata $envelope_metadata envelope_metadata + * * @return $this */ public function setEnvelopeMetadata($envelope_metadata) @@ -1273,6 +1514,7 @@ public function setEnvelopeMetadata($envelope_metadata) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -1282,7 +1524,9 @@ public function getEnvelopeUri() /** * Sets envelope_uri + * * @param string $envelope_uri Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. + * * @return $this */ public function setEnvelopeUri($envelope_uri) @@ -1294,6 +1538,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets expire_after + * * @return string */ public function getExpireAfter() @@ -1303,7 +1548,9 @@ public function getExpireAfter() /** * Sets expire_after + * * @param string $expire_after + * * @return $this */ public function setExpireAfter($expire_after) @@ -1315,6 +1562,7 @@ public function setExpireAfter($expire_after) /** * Gets expire_date_time + * * @return string */ public function getExpireDateTime() @@ -1324,7 +1572,9 @@ public function getExpireDateTime() /** * Sets expire_date_time + * * @param string $expire_date_time + * * @return $this */ public function setExpireDateTime($expire_date_time) @@ -1336,6 +1586,7 @@ public function setExpireDateTime($expire_date_time) /** * Gets expire_enabled + * * @return string */ public function getExpireEnabled() @@ -1345,7 +1596,9 @@ public function getExpireEnabled() /** * Sets expire_enabled + * * @param string $expire_enabled + * * @return $this */ public function setExpireEnabled($expire_enabled) @@ -1357,6 +1610,7 @@ public function setExpireEnabled($expire_enabled) /** * Gets external_envelope_id + * * @return string */ public function getExternalEnvelopeId() @@ -1366,7 +1620,9 @@ public function getExternalEnvelopeId() /** * Sets external_envelope_id + * * @param string $external_envelope_id + * * @return $this */ public function setExternalEnvelopeId($external_envelope_id) @@ -1378,6 +1634,7 @@ public function setExternalEnvelopeId($external_envelope_id) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -1387,7 +1644,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders + * * @return $this */ public function setFolders($folders) @@ -1399,6 +1658,7 @@ public function setFolders($folders) /** * Gets has_comments + * * @return string */ public function getHasComments() @@ -1408,7 +1668,9 @@ public function getHasComments() /** * Sets has_comments + * * @param string $has_comments + * * @return $this */ public function setHasComments($has_comments) @@ -1420,6 +1682,7 @@ public function setHasComments($has_comments) /** * Gets has_form_data_changed + * * @return string */ public function getHasFormDataChanged() @@ -1429,7 +1692,9 @@ public function getHasFormDataChanged() /** * Sets has_form_data_changed + * * @param string $has_form_data_changed + * * @return $this */ public function setHasFormDataChanged($has_form_data_changed) @@ -1441,6 +1706,7 @@ public function setHasFormDataChanged($has_form_data_changed) /** * Gets has_wav_file + * * @return string */ public function getHasWavFile() @@ -1450,7 +1716,9 @@ public function getHasWavFile() /** * Sets has_wav_file + * * @param string $has_wav_file + * * @return $this */ public function setHasWavFile($has_wav_file) @@ -1462,6 +1730,7 @@ public function setHasWavFile($has_wav_file) /** * Gets holder + * * @return string */ public function getHolder() @@ -1471,7 +1740,9 @@ public function getHolder() /** * Sets holder + * * @param string $holder + * * @return $this */ public function setHolder($holder) @@ -1483,6 +1754,7 @@ public function setHolder($holder) /** * Gets initial_sent_date_time + * * @return string */ public function getInitialSentDateTime() @@ -1492,7 +1764,9 @@ public function getInitialSentDateTime() /** * Sets initial_sent_date_time + * * @param string $initial_sent_date_time + * * @return $this */ public function setInitialSentDateTime($initial_sent_date_time) @@ -1504,6 +1778,7 @@ public function setInitialSentDateTime($initial_sent_date_time) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -1513,7 +1788,9 @@ public function getIs21CfrPart11() /** * Sets is21_cfr_part11 + * * @param string $is21_cfr_part11 When set to **true**, indicates that this module is enabled on the account. + * * @return $this */ public function setIs21CfrPart11($is21_cfr_part11) @@ -1525,6 +1802,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets is_dynamic_envelope + * * @return string */ public function getIsDynamicEnvelope() @@ -1534,7 +1812,9 @@ public function getIsDynamicEnvelope() /** * Sets is_dynamic_envelope + * * @param string $is_dynamic_envelope + * * @return $this */ public function setIsDynamicEnvelope($is_dynamic_envelope) @@ -1546,6 +1826,7 @@ public function setIsDynamicEnvelope($is_dynamic_envelope) /** * Gets is_signature_provider_envelope + * * @return string */ public function getIsSignatureProviderEnvelope() @@ -1555,7 +1836,9 @@ public function getIsSignatureProviderEnvelope() /** * Sets is_signature_provider_envelope + * * @param string $is_signature_provider_envelope + * * @return $this */ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) @@ -1567,6 +1850,7 @@ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -1576,7 +1860,9 @@ public function getLastModifiedDateTime() /** * Sets last_modified_date_time + * * @param string $last_modified_date_time The date and time the item was last modified. + * * @return $this */ public function setLastModifiedDateTime($last_modified_date_time) @@ -1588,6 +1874,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets location + * * @return string */ public function getLocation() @@ -1597,7 +1884,9 @@ public function getLocation() /** * Sets location + * * @param string $location + * * @return $this */ public function setLocation($location) @@ -1609,6 +1898,7 @@ public function setLocation($location) /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -1618,7 +1908,9 @@ public function getLockInformation() /** * Sets lock_information - * @param \DocuSign\eSign\Model\LockInformation $lock_information + * + * @param \DocuSign\eSign\Model\LockInformation $lock_information lock_information + * * @return $this */ public function setLockInformation($lock_information) @@ -1630,6 +1922,7 @@ public function setLockInformation($lock_information) /** * Gets message_lock + * * @return string */ public function getMessageLock() @@ -1639,7 +1932,9 @@ public function getMessageLock() /** * Sets message_lock + * * @param string $message_lock When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. + * * @return $this */ public function setMessageLock($message_lock) @@ -1651,6 +1946,7 @@ public function setMessageLock($message_lock) /** * Gets notification + * * @return \DocuSign\eSign\Model\Notification */ public function getNotification() @@ -1660,7 +1956,9 @@ public function getNotification() /** * Sets notification - * @param \DocuSign\eSign\Model\Notification $notification + * + * @param \DocuSign\eSign\Model\Notification $notification notification + * * @return $this */ public function setNotification($notification) @@ -1672,6 +1970,7 @@ public function setNotification($notification) /** * Gets notification_uri + * * @return string */ public function getNotificationUri() @@ -1681,7 +1980,9 @@ public function getNotificationUri() /** * Sets notification_uri + * * @param string $notification_uri Contains a URI for an endpoint that you can use to retrieve the notifications. + * * @return $this */ public function setNotificationUri($notification_uri) @@ -1693,6 +1994,7 @@ public function setNotificationUri($notification_uri) /** * Gets power_form + * * @return \DocuSign\eSign\Model\PowerForm */ public function getPowerForm() @@ -1702,7 +2004,9 @@ public function getPowerForm() /** * Sets power_form - * @param \DocuSign\eSign\Model\PowerForm $power_form + * + * @param \DocuSign\eSign\Model\PowerForm $power_form power_form + * * @return $this */ public function setPowerForm($power_form) @@ -1714,6 +2018,7 @@ public function setPowerForm($power_form) /** * Gets purge_completed_date + * * @return string */ public function getPurgeCompletedDate() @@ -1723,7 +2028,9 @@ public function getPurgeCompletedDate() /** * Sets purge_completed_date + * * @param string $purge_completed_date + * * @return $this */ public function setPurgeCompletedDate($purge_completed_date) @@ -1735,6 +2042,7 @@ public function setPurgeCompletedDate($purge_completed_date) /** * Gets purge_request_date + * * @return string */ public function getPurgeRequestDate() @@ -1744,7 +2052,9 @@ public function getPurgeRequestDate() /** * Sets purge_request_date + * * @param string $purge_request_date + * * @return $this */ public function setPurgeRequestDate($purge_request_date) @@ -1756,6 +2066,7 @@ public function setPurgeRequestDate($purge_request_date) /** * Gets purge_state + * * @return string */ public function getPurgeState() @@ -1765,7 +2076,9 @@ public function getPurgeState() /** * Sets purge_state + * * @param string $purge_state + * * @return $this */ public function setPurgeState($purge_state) @@ -1777,6 +2090,7 @@ public function setPurgeState($purge_state) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -1786,7 +2100,9 @@ public function getRecipients() /** * Sets recipients - * @param \DocuSign\eSign\Model\Recipients $recipients + * + * @param \DocuSign\eSign\Model\Recipients $recipients recipients + * * @return $this */ public function setRecipients($recipients) @@ -1798,6 +2114,7 @@ public function setRecipients($recipients) /** * Gets recipients_lock + * * @return string */ public function getRecipientsLock() @@ -1807,7 +2124,9 @@ public function getRecipientsLock() /** * Sets recipients_lock + * * @param string $recipients_lock When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. + * * @return $this */ public function setRecipientsLock($recipients_lock) @@ -1819,6 +2138,7 @@ public function setRecipientsLock($recipients_lock) /** * Gets recipients_uri + * * @return string */ public function getRecipientsUri() @@ -1828,7 +2148,9 @@ public function getRecipientsUri() /** * Sets recipients_uri + * * @param string $recipients_uri Contains a URI for an endpoint that you can use to retrieve the recipients. + * * @return $this */ public function setRecipientsUri($recipients_uri) @@ -1840,6 +2162,7 @@ public function setRecipientsUri($recipients_uri) /** * Gets sender + * * @return \DocuSign\eSign\Model\UserInfo */ public function getSender() @@ -1849,7 +2172,9 @@ public function getSender() /** * Sets sender - * @param \DocuSign\eSign\Model\UserInfo $sender + * + * @param \DocuSign\eSign\Model\UserInfo $sender sender + * * @return $this */ public function setSender($sender) @@ -1861,6 +2186,7 @@ public function setSender($sender) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1870,7 +2196,9 @@ public function getSentDateTime() /** * 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) @@ -1882,6 +2210,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signer_can_sign_on_mobile + * * @return string */ public function getSignerCanSignOnMobile() @@ -1891,7 +2220,9 @@ public function getSignerCanSignOnMobile() /** * Sets signer_can_sign_on_mobile + * * @param string $signer_can_sign_on_mobile + * * @return $this */ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) @@ -1903,6 +2234,7 @@ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) /** * Gets signing_location + * * @return string */ public function getSigningLocation() @@ -1912,7 +2244,9 @@ public function getSigningLocation() /** * 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) @@ -1924,6 +2258,7 @@ public function setSigningLocation($signing_location) /** * Gets status + * * @return string */ public function getStatus() @@ -1933,7 +2268,9 @@ public function getStatus() /** * 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) @@ -1945,6 +2282,7 @@ public function setStatus($status) /** * Gets status_changed_date_time + * * @return string */ public function getStatusChangedDateTime() @@ -1954,7 +2292,9 @@ public function getStatusChangedDateTime() /** * Sets status_changed_date_time + * * @param string $status_changed_date_time The data and time the status changed. + * * @return $this */ public function setStatusChangedDateTime($status_changed_date_time) @@ -1966,6 +2306,7 @@ public function setStatusChangedDateTime($status_changed_date_time) /** * Gets status_date_time + * * @return string */ public function getStatusDateTime() @@ -1975,7 +2316,9 @@ public function getStatusDateTime() /** * Sets status_date_time + * * @param string $status_date_time + * * @return $this */ public function setStatusDateTime($status_date_time) @@ -1987,6 +2330,7 @@ public function setStatusDateTime($status_date_time) /** * Gets templates_uri + * * @return string */ public function getTemplatesUri() @@ -1996,7 +2340,9 @@ public function getTemplatesUri() /** * Sets templates_uri + * * @param string $templates_uri Contains a URI for an endpoint which you can use to retrieve the templates. + * * @return $this */ public function setTemplatesUri($templates_uri) @@ -2008,6 +2354,7 @@ public function setTemplatesUri($templates_uri) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -2017,7 +2364,9 @@ public function getTransactionId() /** * 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) @@ -2029,6 +2378,7 @@ public function setTransactionId($transaction_id) /** * Gets use_disclosure + * * @return string */ public function getUseDisclosure() @@ -2038,7 +2388,9 @@ 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. + * * @return $this */ public function setUseDisclosure($use_disclosure) @@ -2050,6 +2402,7 @@ public function setUseDisclosure($use_disclosure) /** * Gets voided_date_time + * * @return string */ public function getVoidedDateTime() @@ -2059,7 +2412,9 @@ public function getVoidedDateTime() /** * Sets voided_date_time + * * @param string $voided_date_time The date and time the envelope or template was voided. + * * @return $this */ public function setVoidedDateTime($voided_date_time) @@ -2071,6 +2426,7 @@ public function setVoidedDateTime($voided_date_time) /** * Gets voided_reason + * * @return string */ public function getVoidedReason() @@ -2080,7 +2436,9 @@ public function getVoidedReason() /** * Sets voided_reason + * * @param string $voided_reason The reason the envelope or template was voided. + * * @return $this */ public function setVoidedReason($voided_reason) @@ -2091,7 +2449,9 @@ public function setVoidedReason($voided_reason) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2101,7 +2461,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2111,8 +2473,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2126,7 +2490,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2136,16 +2502,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeAttachment.php b/src/Model/EnvelopeAttachment.php index b83a701b..d8ea2161 100644 --- a/src/Model/EnvelopeAttachment.php +++ b/src/Model/EnvelopeAttachment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeAttachment Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeAttachment implements ArrayAccess +class EnvelopeAttachment implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeAttachment'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class EnvelopeAttachment implements ArrayAccess 'name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_control' => null, + 'attachment_id' => null, + 'attachment_type' => null, + 'error_details' => null, + 'label' => null, + 'name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'name' => 'name' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'name' => 'setName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'name' => 'getName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_control + * * @return string */ public function getAccessControl() @@ -181,7 +246,9 @@ public function getAccessControl() /** * Sets access_control + * * @param string $access_control + * * @return $this */ public function setAccessControl($access_control) @@ -193,6 +260,7 @@ public function setAccessControl($access_control) /** * Gets attachment_id + * * @return string */ public function getAttachmentId() @@ -202,7 +270,9 @@ public function getAttachmentId() /** * Sets attachment_id + * * @param string $attachment_id + * * @return $this */ public function setAttachmentId($attachment_id) @@ -214,6 +284,7 @@ public function setAttachmentId($attachment_id) /** * Gets attachment_type + * * @return string */ public function getAttachmentType() @@ -223,7 +294,9 @@ public function getAttachmentType() /** * Sets attachment_type + * * @param string $attachment_type + * * @return $this */ public function setAttachmentType($attachment_type) @@ -235,6 +308,7 @@ public function setAttachmentType($attachment_type) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -244,7 +318,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -256,6 +332,7 @@ public function setErrorDetails($error_details) /** * Gets label + * * @return string */ public function getLabel() @@ -265,7 +342,9 @@ public function getLabel() /** * Sets label + * * @param string $label + * * @return $this */ public function setLabel($label) @@ -277,6 +356,7 @@ public function setLabel($label) /** * Gets name + * * @return string */ public function getName() @@ -286,7 +366,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -297,7 +379,9 @@ public function setName($name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeAttachmentsRequest.php b/src/Model/EnvelopeAttachmentsRequest.php index 0575a0e5..53f92725 100644 --- a/src/Model/EnvelopeAttachmentsRequest.php +++ b/src/Model/EnvelopeAttachmentsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeAttachmentsRequest Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeAttachmentsRequest implements ArrayAccess +class EnvelopeAttachmentsRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeAttachmentsRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'attachments' => '\DocuSign\eSign\Model\Attachment[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'attachments' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'attachments' => 'attachments' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'attachments' => 'setAttachments' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'attachments' => 'getAttachments' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets attachments + * * @return \DocuSign\eSign\Model\Attachment[] */ public function getAttachments() @@ -156,7 +216,9 @@ public function getAttachments() /** * Sets attachments + * * @param \DocuSign\eSign\Model\Attachment[] $attachments + * * @return $this */ public function setAttachments($attachments) @@ -167,7 +229,9 @@ public function setAttachments($attachments) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeAttachmentsResult.php b/src/Model/EnvelopeAttachmentsResult.php index f94429d7..11c6e451 100644 --- a/src/Model/EnvelopeAttachmentsResult.php +++ b/src/Model/EnvelopeAttachmentsResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeAttachmentsResult Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeAttachmentsResult implements ArrayAccess +class EnvelopeAttachmentsResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeAttachmentsResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'attachments' => '\DocuSign\eSign\Model\EnvelopeAttachment[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'attachments' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'attachments' => 'attachments' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'attachments' => 'setAttachments' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'attachments' => 'getAttachments' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets attachments + * * @return \DocuSign\eSign\Model\EnvelopeAttachment[] */ public function getAttachments() @@ -156,7 +216,9 @@ public function getAttachments() /** * Sets attachments + * * @param \DocuSign\eSign\Model\EnvelopeAttachment[] $attachments + * * @return $this */ public function setAttachments($attachments) @@ -167,7 +229,9 @@ public function setAttachments($attachments) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeAuditEvent.php b/src/Model/EnvelopeAuditEvent.php index d2490f85..94578d3d 100644 --- a/src/Model/EnvelopeAuditEvent.php +++ b/src/Model/EnvelopeAuditEvent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeAuditEvent Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeAuditEvent implements ArrayAccess +class EnvelopeAuditEvent implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeAuditEvent'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'event_fields' => '\DocuSign\eSign\Model\NameValue[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'event_fields' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'event_fields' => 'eventFields' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'event_fields' => 'setEventFields' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'event_fields' => 'getEventFields' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets event_fields + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getEventFields() @@ -156,7 +216,9 @@ public function getEventFields() /** * Sets event_fields + * * @param \DocuSign\eSign\Model\NameValue[] $event_fields + * * @return $this */ public function setEventFields($event_fields) @@ -167,7 +229,9 @@ public function setEventFields($event_fields) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeAuditEventResponse.php b/src/Model/EnvelopeAuditEventResponse.php index b5949645..f8bf2bb5 100644 --- a/src/Model/EnvelopeAuditEventResponse.php +++ b/src/Model/EnvelopeAuditEventResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeAuditEventResponse Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeAuditEventResponse implements ArrayAccess +class EnvelopeAuditEventResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeAuditEventResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'audit_events' => '\DocuSign\eSign\Model\EnvelopeAuditEvent[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'audit_events' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'audit_events' => 'auditEvents' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'audit_events' => 'setAuditEvents' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'audit_events' => 'getAuditEvents' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets audit_events + * * @return \DocuSign\eSign\Model\EnvelopeAuditEvent[] */ public function getAuditEvents() @@ -156,7 +216,9 @@ public function getAuditEvents() /** * Sets audit_events + * * @param \DocuSign\eSign\Model\EnvelopeAuditEvent[] $audit_events Reserved: TBD + * * @return $this */ public function setAuditEvents($audit_events) @@ -167,7 +229,9 @@ public function setAuditEvents($audit_events) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeDefinition.php b/src/Model/EnvelopeDefinition.php index 9040f598..fd65b54f 100644 --- a/src/Model/EnvelopeDefinition.php +++ b/src/Model/EnvelopeDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeDefinition Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeDefinition implements ArrayAccess +class EnvelopeDefinition implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeDefinition'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -141,13 +144,123 @@ class EnvelopeDefinition implements ArrayAccess 'voided_reason' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_control_list_base64' => null, + 'accessibility' => null, + 'allow_comments' => null, + 'allow_markup' => null, + 'allow_reassign' => null, + 'allow_recipient_recursion' => null, + 'allow_view_history' => null, + 'any_signer' => null, + 'asynchronous' => null, + 'attachments' => null, + 'attachments_uri' => null, + 'authoritative_copy' => null, + 'authoritative_copy_default' => null, + 'auto_navigation' => null, + 'brand_id' => null, + 'brand_lock' => null, + 'certificate_uri' => null, + 'completed_date_time' => null, + 'composite_templates' => null, + 'copy_recipient_data' => null, + 'created_date_time' => null, + 'custom_fields' => null, + 'custom_fields_uri' => null, + 'declined_date_time' => null, + 'deleted_date_time' => null, + 'delivered_date_time' => null, + 'disable_responsive_document' => null, + 'documents' => null, + 'documents_combined_uri' => null, + 'documents_uri' => null, + 'email_blurb' => null, + 'email_settings' => null, + 'email_subject' => null, + 'enable_wet_sign' => null, + 'enforce_signer_visibility' => null, + 'envelope_attachments' => null, + 'envelope_documents' => null, + 'envelope_id' => null, + 'envelope_id_stamping' => null, + 'envelope_location' => null, + 'envelope_metadata' => null, + 'envelope_uri' => null, + 'event_notification' => null, + 'event_notifications' => null, + 'expire_after' => null, + 'expire_date_time' => null, + 'expire_enabled' => null, + 'external_envelope_id' => null, + 'folders' => null, + 'has_comments' => null, + 'has_form_data_changed' => null, + 'has_wav_file' => null, + 'holder' => null, + 'initial_sent_date_time' => null, + 'is21_cfr_part11' => null, + 'is_dynamic_envelope' => null, + 'is_signature_provider_envelope' => null, + 'last_modified_date_time' => null, + 'location' => null, + 'lock_information' => null, + 'message_lock' => null, + 'notification' => null, + 'notification_uri' => null, + 'password' => null, + 'power_form' => null, + 'purge_completed_date' => null, + 'purge_request_date' => null, + 'purge_state' => null, + 'recipients' => null, + 'recipients_lock' => null, + 'recipients_uri' => null, + 'sender' => null, + 'sent_date_time' => null, + 'signer_can_sign_on_mobile' => null, + 'signing_location' => null, + 'status' => null, + 'status_changed_date_time' => null, + 'status_date_time' => null, + 'template_id' => null, + 'template_roles' => null, + 'templates_uri' => null, + 'transaction_id' => null, + 'use_disclosure' => null, + 'voided_date_time' => null, + 'voided_reason' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -238,9 +351,9 @@ public static function swaggerTypes() 'voided_reason' => 'voidedReason' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -331,9 +444,9 @@ public static function swaggerTypes() 'voided_reason' => 'setVoidedReason' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -424,34 +537,63 @@ public static function swaggerTypes() 'voided_reason' => 'getVoidedReason' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -543,30 +685,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_control_list_base64 + * * @return string */ public function getAccessControlListBase64() @@ -576,7 +720,9 @@ public function getAccessControlListBase64() /** * Sets access_control_list_base64 + * * @param string $access_control_list_base64 + * * @return $this */ public function setAccessControlListBase64($access_control_list_base64) @@ -588,6 +734,7 @@ public function setAccessControlListBase64($access_control_list_base64) /** * Gets accessibility + * * @return string */ public function getAccessibility() @@ -597,7 +744,9 @@ public function getAccessibility() /** * Sets accessibility + * * @param string $accessibility Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. ###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here. + * * @return $this */ public function setAccessibility($accessibility) @@ -609,6 +758,7 @@ public function setAccessibility($accessibility) /** * Gets allow_comments + * * @return string */ public function getAllowComments() @@ -618,7 +768,9 @@ public function getAllowComments() /** * Sets allow_comments + * * @param string $allow_comments + * * @return $this */ public function setAllowComments($allow_comments) @@ -630,6 +782,7 @@ public function setAllowComments($allow_comments) /** * Gets allow_markup + * * @return string */ public function getAllowMarkup() @@ -639,7 +792,9 @@ public function getAllowMarkup() /** * Sets allow_markup + * * @param string $allow_markup When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this + * * @return $this */ public function setAllowMarkup($allow_markup) @@ -651,6 +806,7 @@ public function setAllowMarkup($allow_markup) /** * Gets allow_reassign + * * @return string */ public function getAllowReassign() @@ -660,7 +816,9 @@ public function getAllowReassign() /** * Sets allow_reassign + * * @param string $allow_reassign When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. + * * @return $this */ public function setAllowReassign($allow_reassign) @@ -672,6 +830,7 @@ public function setAllowReassign($allow_reassign) /** * Gets allow_recipient_recursion + * * @return string */ public function getAllowRecipientRecursion() @@ -681,7 +840,9 @@ public function getAllowRecipientRecursion() /** * Sets allow_recipient_recursion + * * @param string $allow_recipient_recursion When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order. + * * @return $this */ public function setAllowRecipientRecursion($allow_recipient_recursion) @@ -693,6 +854,7 @@ public function setAllowRecipientRecursion($allow_recipient_recursion) /** * Gets allow_view_history + * * @return string */ public function getAllowViewHistory() @@ -702,7 +864,9 @@ public function getAllowViewHistory() /** * Sets allow_view_history + * * @param string $allow_view_history + * * @return $this */ public function setAllowViewHistory($allow_view_history) @@ -714,6 +878,7 @@ public function setAllowViewHistory($allow_view_history) /** * Gets any_signer + * * @return string */ public function getAnySigner() @@ -723,7 +888,9 @@ public function getAnySigner() /** * Sets any_signer + * * @param string $any_signer + * * @return $this */ public function setAnySigner($any_signer) @@ -735,6 +902,7 @@ public function setAnySigner($any_signer) /** * Gets asynchronous + * * @return string */ public function getAsynchronous() @@ -744,7 +912,9 @@ public function getAsynchronous() /** * Sets asynchronous + * * @param string $asynchronous When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. + * * @return $this */ public function setAsynchronous($asynchronous) @@ -756,6 +926,7 @@ public function setAsynchronous($asynchronous) /** * Gets attachments + * * @return \DocuSign\eSign\Model\Attachment[] */ public function getAttachments() @@ -765,7 +936,9 @@ public function getAttachments() /** * Sets attachments + * * @param \DocuSign\eSign\Model\Attachment[] $attachments + * * @return $this */ public function setAttachments($attachments) @@ -777,6 +950,7 @@ public function setAttachments($attachments) /** * Gets attachments_uri + * * @return string */ public function getAttachmentsUri() @@ -786,7 +960,9 @@ public function getAttachmentsUri() /** * Sets attachments_uri + * * @param string $attachments_uri + * * @return $this */ public function setAttachmentsUri($attachments_uri) @@ -798,6 +974,7 @@ public function setAttachmentsUri($attachments_uri) /** * Gets authoritative_copy + * * @return string */ public function getAuthoritativeCopy() @@ -807,7 +984,9 @@ public function getAuthoritativeCopy() /** * 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) @@ -819,6 +998,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets authoritative_copy_default + * * @return string */ public function getAuthoritativeCopyDefault() @@ -828,7 +1008,9 @@ public function getAuthoritativeCopyDefault() /** * Sets authoritative_copy_default + * * @param string $authoritative_copy_default + * * @return $this */ public function setAuthoritativeCopyDefault($authoritative_copy_default) @@ -840,6 +1022,7 @@ public function setAuthoritativeCopyDefault($authoritative_copy_default) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -849,7 +1032,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -861,6 +1046,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -870,7 +1056,9 @@ public function getBrandId() /** * Sets brand_id + * * @param string $brand_id This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option. + * * @return $this */ public function setBrandId($brand_id) @@ -882,6 +1070,7 @@ public function setBrandId($brand_id) /** * Gets brand_lock + * * @return string */ public function getBrandLock() @@ -891,7 +1080,9 @@ public function getBrandLock() /** * Sets brand_lock + * * @param string $brand_lock + * * @return $this */ public function setBrandLock($brand_lock) @@ -903,6 +1094,7 @@ public function setBrandLock($brand_lock) /** * Gets certificate_uri + * * @return string */ public function getCertificateUri() @@ -912,7 +1104,9 @@ public function getCertificateUri() /** * Sets certificate_uri + * * @param string $certificate_uri Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. + * * @return $this */ public function setCertificateUri($certificate_uri) @@ -924,6 +1118,7 @@ public function setCertificateUri($certificate_uri) /** * Gets completed_date_time + * * @return string */ public function getCompletedDateTime() @@ -933,7 +1128,9 @@ public function getCompletedDateTime() /** * Sets completed_date_time + * * @param string $completed_date_time Specifies the date and time this item was completed. + * * @return $this */ public function setCompletedDateTime($completed_date_time) @@ -945,6 +1142,7 @@ public function setCompletedDateTime($completed_date_time) /** * Gets composite_templates + * * @return \DocuSign\eSign\Model\CompositeTemplate[] */ public function getCompositeTemplates() @@ -954,7 +1152,9 @@ public function getCompositeTemplates() /** * Sets composite_templates + * * @param \DocuSign\eSign\Model\CompositeTemplate[] $composite_templates A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope. + * * @return $this */ public function setCompositeTemplates($composite_templates) @@ -966,6 +1166,7 @@ public function setCompositeTemplates($composite_templates) /** * Gets copy_recipient_data + * * @return string */ public function getCopyRecipientData() @@ -975,7 +1176,9 @@ public function getCopyRecipientData() /** * Sets copy_recipient_data + * * @param string $copy_recipient_data + * * @return $this */ public function setCopyRecipientData($copy_recipient_data) @@ -987,6 +1190,7 @@ public function setCopyRecipientData($copy_recipient_data) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -996,7 +1200,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -1008,6 +1214,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\CustomFields */ public function getCustomFields() @@ -1017,7 +1224,9 @@ public function getCustomFields() /** * Sets custom_fields - * @param \DocuSign\eSign\Model\CustomFields $custom_fields + * + * @param \DocuSign\eSign\Model\CustomFields $custom_fields custom_fields + * * @return $this */ public function setCustomFields($custom_fields) @@ -1029,6 +1238,7 @@ public function setCustomFields($custom_fields) /** * Gets custom_fields_uri + * * @return string */ public function getCustomFieldsUri() @@ -1038,7 +1248,9 @@ public function getCustomFieldsUri() /** * Sets custom_fields_uri + * * @param string $custom_fields_uri Contains a URI for an endpoint that you can use to retrieve the custom fields. + * * @return $this */ public function setCustomFieldsUri($custom_fields_uri) @@ -1050,6 +1262,7 @@ public function setCustomFieldsUri($custom_fields_uri) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -1059,7 +1272,9 @@ public function getDeclinedDateTime() /** * 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) @@ -1071,6 +1286,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets deleted_date_time + * * @return string */ public function getDeletedDateTime() @@ -1080,7 +1296,9 @@ public function getDeletedDateTime() /** * Sets deleted_date_time + * * @param string $deleted_date_time Specifies the data and time the item was deleted. + * * @return $this */ public function setDeletedDateTime($deleted_date_time) @@ -1092,6 +1310,7 @@ public function setDeletedDateTime($deleted_date_time) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -1101,7 +1320,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -1113,6 +1334,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets disable_responsive_document + * * @return string */ public function getDisableResponsiveDocument() @@ -1122,7 +1344,9 @@ public function getDisableResponsiveDocument() /** * Sets disable_responsive_document + * * @param string $disable_responsive_document + * * @return $this */ public function setDisableResponsiveDocument($disable_responsive_document) @@ -1134,6 +1358,7 @@ public function setDisableResponsiveDocument($disable_responsive_document) /** * Gets documents + * * @return \DocuSign\eSign\Model\Document[] */ public function getDocuments() @@ -1143,7 +1368,9 @@ public function getDocuments() /** * Sets documents + * * @param \DocuSign\eSign\Model\Document[] $documents Complex element contains the details on the documents in the envelope. + * * @return $this */ public function setDocuments($documents) @@ -1155,6 +1382,7 @@ public function setDocuments($documents) /** * Gets documents_combined_uri + * * @return string */ public function getDocumentsCombinedUri() @@ -1164,7 +1392,9 @@ public function getDocumentsCombinedUri() /** * Sets documents_combined_uri + * * @param string $documents_combined_uri + * * @return $this */ public function setDocumentsCombinedUri($documents_combined_uri) @@ -1176,6 +1406,7 @@ public function setDocumentsCombinedUri($documents_combined_uri) /** * Gets documents_uri + * * @return string */ public function getDocumentsUri() @@ -1185,7 +1416,9 @@ public function getDocumentsUri() /** * Sets documents_uri + * * @param string $documents_uri Contains a URI for an endpoint that you can use to retrieve the documents. + * * @return $this */ public function setDocumentsUri($documents_uri) @@ -1197,6 +1430,7 @@ public function setDocumentsUri($documents_uri) /** * Gets email_blurb + * * @return string */ public function getEmailBlurb() @@ -1206,7 +1440,9 @@ public function getEmailBlurb() /** * Sets email_blurb + * * @param string $email_blurb Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters + * * @return $this */ public function setEmailBlurb($email_blurb) @@ -1218,6 +1454,7 @@ public function setEmailBlurb($email_blurb) /** * Gets email_settings + * * @return \DocuSign\eSign\Model\EmailSettings */ public function getEmailSettings() @@ -1227,7 +1464,9 @@ public function getEmailSettings() /** * Sets email_settings - * @param \DocuSign\eSign\Model\EmailSettings $email_settings + * + * @param \DocuSign\eSign\Model\EmailSettings $email_settings email_settings + * * @return $this */ public function setEmailSettings($email_settings) @@ -1239,6 +1478,7 @@ public function setEmailSettings($email_settings) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -1248,7 +1488,9 @@ public function getEmailSubject() /** * Sets email_subject + * * @param string $email_subject Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. + * * @return $this */ public function setEmailSubject($email_subject) @@ -1260,6 +1502,7 @@ public function setEmailSubject($email_subject) /** * Gets enable_wet_sign + * * @return string */ public function getEnableWetSign() @@ -1269,7 +1512,9 @@ public function getEnableWetSign() /** * Sets enable_wet_sign + * * @param string $enable_wet_sign When set to **true**, the signer is allowed to print the document and sign it on paper. + * * @return $this */ public function setEnableWetSign($enable_wet_sign) @@ -1281,6 +1526,7 @@ public function setEnableWetSign($enable_wet_sign) /** * Gets enforce_signer_visibility + * * @return string */ public function getEnforceSignerVisibility() @@ -1290,7 +1536,9 @@ public function getEnforceSignerVisibility() /** * Sets enforce_signer_visibility + * * @param string $enforce_signer_visibility When set to **true**, 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. Your account must have Document Visibility enabled to use this. + * * @return $this */ public function setEnforceSignerVisibility($enforce_signer_visibility) @@ -1302,6 +1550,7 @@ public function setEnforceSignerVisibility($enforce_signer_visibility) /** * Gets envelope_attachments + * * @return \DocuSign\eSign\Model\Attachment[] */ public function getEnvelopeAttachments() @@ -1311,7 +1560,9 @@ public function getEnvelopeAttachments() /** * Sets envelope_attachments + * * @param \DocuSign\eSign\Model\Attachment[] $envelope_attachments + * * @return $this */ public function setEnvelopeAttachments($envelope_attachments) @@ -1323,6 +1574,7 @@ public function setEnvelopeAttachments($envelope_attachments) /** * Gets envelope_documents + * * @return \DocuSign\eSign\Model\EnvelopeDocument[] */ public function getEnvelopeDocuments() @@ -1332,7 +1584,9 @@ public function getEnvelopeDocuments() /** * Sets envelope_documents + * * @param \DocuSign\eSign\Model\EnvelopeDocument[] $envelope_documents + * * @return $this */ public function setEnvelopeDocuments($envelope_documents) @@ -1344,6 +1598,7 @@ public function setEnvelopeDocuments($envelope_documents) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -1353,7 +1608,9 @@ public function getEnvelopeId() /** * 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) @@ -1365,6 +1622,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_id_stamping + * * @return string */ public function getEnvelopeIdStamping() @@ -1374,7 +1632,9 @@ public function getEnvelopeIdStamping() /** * Sets envelope_id_stamping + * * @param string $envelope_id_stamping When set to **true**, Envelope ID Stamping is enabled. + * * @return $this */ public function setEnvelopeIdStamping($envelope_id_stamping) @@ -1386,6 +1646,7 @@ public function setEnvelopeIdStamping($envelope_id_stamping) /** * Gets envelope_location + * * @return string */ public function getEnvelopeLocation() @@ -1395,7 +1656,9 @@ public function getEnvelopeLocation() /** * Sets envelope_location + * * @param string $envelope_location + * * @return $this */ public function setEnvelopeLocation($envelope_location) @@ -1407,6 +1670,7 @@ public function setEnvelopeLocation($envelope_location) /** * Gets envelope_metadata + * * @return \DocuSign\eSign\Model\EnvelopeMetadata */ public function getEnvelopeMetadata() @@ -1416,7 +1680,9 @@ public function getEnvelopeMetadata() /** * Sets envelope_metadata - * @param \DocuSign\eSign\Model\EnvelopeMetadata $envelope_metadata + * + * @param \DocuSign\eSign\Model\EnvelopeMetadata $envelope_metadata envelope_metadata + * * @return $this */ public function setEnvelopeMetadata($envelope_metadata) @@ -1428,6 +1694,7 @@ public function setEnvelopeMetadata($envelope_metadata) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -1437,7 +1704,9 @@ public function getEnvelopeUri() /** * Sets envelope_uri + * * @param string $envelope_uri Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. + * * @return $this */ public function setEnvelopeUri($envelope_uri) @@ -1449,6 +1718,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets event_notification + * * @return \DocuSign\eSign\Model\EventNotification */ public function getEventNotification() @@ -1458,7 +1728,9 @@ public function getEventNotification() /** * Sets event_notification - * @param \DocuSign\eSign\Model\EventNotification $event_notification + * + * @param \DocuSign\eSign\Model\EventNotification $event_notification event_notification + * * @return $this */ public function setEventNotification($event_notification) @@ -1470,6 +1742,7 @@ public function setEventNotification($event_notification) /** * Gets event_notifications + * * @return \DocuSign\eSign\Model\EventNotification[] */ public function getEventNotifications() @@ -1479,7 +1752,9 @@ public function getEventNotifications() /** * Sets event_notifications + * * @param \DocuSign\eSign\Model\EventNotification[] $event_notifications + * * @return $this */ public function setEventNotifications($event_notifications) @@ -1491,6 +1766,7 @@ public function setEventNotifications($event_notifications) /** * Gets expire_after + * * @return string */ public function getExpireAfter() @@ -1500,7 +1776,9 @@ public function getExpireAfter() /** * Sets expire_after + * * @param string $expire_after + * * @return $this */ public function setExpireAfter($expire_after) @@ -1512,6 +1790,7 @@ public function setExpireAfter($expire_after) /** * Gets expire_date_time + * * @return string */ public function getExpireDateTime() @@ -1521,7 +1800,9 @@ public function getExpireDateTime() /** * Sets expire_date_time + * * @param string $expire_date_time + * * @return $this */ public function setExpireDateTime($expire_date_time) @@ -1533,6 +1814,7 @@ public function setExpireDateTime($expire_date_time) /** * Gets expire_enabled + * * @return string */ public function getExpireEnabled() @@ -1542,7 +1824,9 @@ public function getExpireEnabled() /** * Sets expire_enabled + * * @param string $expire_enabled + * * @return $this */ public function setExpireEnabled($expire_enabled) @@ -1554,6 +1838,7 @@ public function setExpireEnabled($expire_enabled) /** * Gets external_envelope_id + * * @return string */ public function getExternalEnvelopeId() @@ -1563,7 +1848,9 @@ public function getExternalEnvelopeId() /** * Sets external_envelope_id + * * @param string $external_envelope_id + * * @return $this */ public function setExternalEnvelopeId($external_envelope_id) @@ -1575,6 +1862,7 @@ public function setExternalEnvelopeId($external_envelope_id) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -1584,7 +1872,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders + * * @return $this */ public function setFolders($folders) @@ -1596,6 +1886,7 @@ public function setFolders($folders) /** * Gets has_comments + * * @return string */ public function getHasComments() @@ -1605,7 +1896,9 @@ public function getHasComments() /** * Sets has_comments + * * @param string $has_comments + * * @return $this */ public function setHasComments($has_comments) @@ -1617,6 +1910,7 @@ public function setHasComments($has_comments) /** * Gets has_form_data_changed + * * @return string */ public function getHasFormDataChanged() @@ -1626,7 +1920,9 @@ public function getHasFormDataChanged() /** * Sets has_form_data_changed + * * @param string $has_form_data_changed + * * @return $this */ public function setHasFormDataChanged($has_form_data_changed) @@ -1638,6 +1934,7 @@ public function setHasFormDataChanged($has_form_data_changed) /** * Gets has_wav_file + * * @return string */ public function getHasWavFile() @@ -1647,7 +1944,9 @@ public function getHasWavFile() /** * Sets has_wav_file + * * @param string $has_wav_file + * * @return $this */ public function setHasWavFile($has_wav_file) @@ -1659,6 +1958,7 @@ public function setHasWavFile($has_wav_file) /** * Gets holder + * * @return string */ public function getHolder() @@ -1668,7 +1968,9 @@ public function getHolder() /** * Sets holder + * * @param string $holder + * * @return $this */ public function setHolder($holder) @@ -1680,6 +1982,7 @@ public function setHolder($holder) /** * Gets initial_sent_date_time + * * @return string */ public function getInitialSentDateTime() @@ -1689,7 +1992,9 @@ public function getInitialSentDateTime() /** * Sets initial_sent_date_time + * * @param string $initial_sent_date_time + * * @return $this */ public function setInitialSentDateTime($initial_sent_date_time) @@ -1701,6 +2006,7 @@ public function setInitialSentDateTime($initial_sent_date_time) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -1710,7 +2016,9 @@ public function getIs21CfrPart11() /** * Sets is21_cfr_part11 + * * @param string $is21_cfr_part11 When set to **true**, indicates that this module is enabled on the account. + * * @return $this */ public function setIs21CfrPart11($is21_cfr_part11) @@ -1722,6 +2030,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets is_dynamic_envelope + * * @return string */ public function getIsDynamicEnvelope() @@ -1731,7 +2040,9 @@ public function getIsDynamicEnvelope() /** * Sets is_dynamic_envelope + * * @param string $is_dynamic_envelope + * * @return $this */ public function setIsDynamicEnvelope($is_dynamic_envelope) @@ -1743,6 +2054,7 @@ public function setIsDynamicEnvelope($is_dynamic_envelope) /** * Gets is_signature_provider_envelope + * * @return string */ public function getIsSignatureProviderEnvelope() @@ -1752,7 +2064,9 @@ public function getIsSignatureProviderEnvelope() /** * Sets is_signature_provider_envelope + * * @param string $is_signature_provider_envelope + * * @return $this */ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) @@ -1764,6 +2078,7 @@ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -1773,7 +2088,9 @@ public function getLastModifiedDateTime() /** * Sets last_modified_date_time + * * @param string $last_modified_date_time The date and time the item was last modified. + * * @return $this */ public function setLastModifiedDateTime($last_modified_date_time) @@ -1785,6 +2102,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets location + * * @return string */ public function getLocation() @@ -1794,7 +2112,9 @@ public function getLocation() /** * Sets location + * * @param string $location + * * @return $this */ public function setLocation($location) @@ -1806,6 +2126,7 @@ public function setLocation($location) /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -1815,7 +2136,9 @@ public function getLockInformation() /** * Sets lock_information - * @param \DocuSign\eSign\Model\LockInformation $lock_information + * + * @param \DocuSign\eSign\Model\LockInformation $lock_information lock_information + * * @return $this */ public function setLockInformation($lock_information) @@ -1827,6 +2150,7 @@ public function setLockInformation($lock_information) /** * Gets message_lock + * * @return string */ public function getMessageLock() @@ -1836,7 +2160,9 @@ public function getMessageLock() /** * Sets message_lock + * * @param string $message_lock When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. + * * @return $this */ public function setMessageLock($message_lock) @@ -1848,6 +2174,7 @@ public function setMessageLock($message_lock) /** * Gets notification + * * @return \DocuSign\eSign\Model\Notification */ public function getNotification() @@ -1857,7 +2184,9 @@ public function getNotification() /** * Sets notification - * @param \DocuSign\eSign\Model\Notification $notification + * + * @param \DocuSign\eSign\Model\Notification $notification notification + * * @return $this */ public function setNotification($notification) @@ -1869,6 +2198,7 @@ public function setNotification($notification) /** * Gets notification_uri + * * @return string */ public function getNotificationUri() @@ -1878,7 +2208,9 @@ public function getNotificationUri() /** * Sets notification_uri + * * @param string $notification_uri Contains a URI for an endpoint that you can use to retrieve the notifications. + * * @return $this */ public function setNotificationUri($notification_uri) @@ -1890,6 +2222,7 @@ public function setNotificationUri($notification_uri) /** * Gets password + * * @return string */ public function getPassword() @@ -1899,7 +2232,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -1911,6 +2246,7 @@ public function setPassword($password) /** * Gets power_form + * * @return \DocuSign\eSign\Model\PowerForm */ public function getPowerForm() @@ -1920,7 +2256,9 @@ public function getPowerForm() /** * Sets power_form - * @param \DocuSign\eSign\Model\PowerForm $power_form + * + * @param \DocuSign\eSign\Model\PowerForm $power_form power_form + * * @return $this */ public function setPowerForm($power_form) @@ -1932,6 +2270,7 @@ public function setPowerForm($power_form) /** * Gets purge_completed_date + * * @return string */ public function getPurgeCompletedDate() @@ -1941,7 +2280,9 @@ public function getPurgeCompletedDate() /** * Sets purge_completed_date + * * @param string $purge_completed_date + * * @return $this */ public function setPurgeCompletedDate($purge_completed_date) @@ -1953,6 +2294,7 @@ public function setPurgeCompletedDate($purge_completed_date) /** * Gets purge_request_date + * * @return string */ public function getPurgeRequestDate() @@ -1962,7 +2304,9 @@ public function getPurgeRequestDate() /** * Sets purge_request_date + * * @param string $purge_request_date + * * @return $this */ public function setPurgeRequestDate($purge_request_date) @@ -1974,6 +2318,7 @@ public function setPurgeRequestDate($purge_request_date) /** * Gets purge_state + * * @return string */ public function getPurgeState() @@ -1983,7 +2328,9 @@ public function getPurgeState() /** * Sets purge_state + * * @param string $purge_state Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue. + * * @return $this */ public function setPurgeState($purge_state) @@ -1995,6 +2342,7 @@ public function setPurgeState($purge_state) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -2004,7 +2352,9 @@ public function getRecipients() /** * Sets recipients - * @param \DocuSign\eSign\Model\Recipients $recipients + * + * @param \DocuSign\eSign\Model\Recipients $recipients recipients + * * @return $this */ public function setRecipients($recipients) @@ -2016,6 +2366,7 @@ public function setRecipients($recipients) /** * Gets recipients_lock + * * @return string */ public function getRecipientsLock() @@ -2025,7 +2376,9 @@ public function getRecipientsLock() /** * Sets recipients_lock + * * @param string $recipients_lock When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. + * * @return $this */ public function setRecipientsLock($recipients_lock) @@ -2037,6 +2390,7 @@ public function setRecipientsLock($recipients_lock) /** * Gets recipients_uri + * * @return string */ public function getRecipientsUri() @@ -2046,7 +2400,9 @@ public function getRecipientsUri() /** * Sets recipients_uri + * * @param string $recipients_uri Contains a URI for an endpoint that you can use to retrieve the recipients. + * * @return $this */ public function setRecipientsUri($recipients_uri) @@ -2058,6 +2414,7 @@ public function setRecipientsUri($recipients_uri) /** * Gets sender + * * @return \DocuSign\eSign\Model\UserInfo */ public function getSender() @@ -2067,7 +2424,9 @@ public function getSender() /** * Sets sender - * @param \DocuSign\eSign\Model\UserInfo $sender + * + * @param \DocuSign\eSign\Model\UserInfo $sender sender + * * @return $this */ public function setSender($sender) @@ -2079,6 +2438,7 @@ public function setSender($sender) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -2088,7 +2448,9 @@ public function getSentDateTime() /** * 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) @@ -2100,6 +2462,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signer_can_sign_on_mobile + * * @return string */ public function getSignerCanSignOnMobile() @@ -2109,7 +2472,9 @@ public function getSignerCanSignOnMobile() /** * Sets signer_can_sign_on_mobile + * * @param string $signer_can_sign_on_mobile + * * @return $this */ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) @@ -2121,6 +2486,7 @@ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) /** * Gets signing_location + * * @return string */ public function getSigningLocation() @@ -2130,7 +2496,9 @@ public function getSigningLocation() /** * 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) @@ -2142,6 +2510,7 @@ public function setSigningLocation($signing_location) /** * Gets status + * * @return string */ public function getStatus() @@ -2151,7 +2520,9 @@ public function getStatus() /** * 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) @@ -2163,6 +2534,7 @@ public function setStatus($status) /** * Gets status_changed_date_time + * * @return string */ public function getStatusChangedDateTime() @@ -2172,7 +2544,9 @@ public function getStatusChangedDateTime() /** * Sets status_changed_date_time + * * @param string $status_changed_date_time The data and time the status changed. + * * @return $this */ public function setStatusChangedDateTime($status_changed_date_time) @@ -2184,6 +2558,7 @@ public function setStatusChangedDateTime($status_changed_date_time) /** * Gets status_date_time + * * @return string */ public function getStatusDateTime() @@ -2193,7 +2568,9 @@ public function getStatusDateTime() /** * Sets status_date_time + * * @param string $status_date_time + * * @return $this */ public function setStatusDateTime($status_date_time) @@ -2205,6 +2582,7 @@ public function setStatusDateTime($status_date_time) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -2214,7 +2592,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -2226,6 +2606,7 @@ public function setTemplateId($template_id) /** * Gets template_roles + * * @return \DocuSign\eSign\Model\TemplateRole[] */ public function getTemplateRoles() @@ -2235,7 +2616,9 @@ 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. + * * @return $this */ public function setTemplateRoles($template_roles) @@ -2247,6 +2630,7 @@ public function setTemplateRoles($template_roles) /** * Gets templates_uri + * * @return string */ public function getTemplatesUri() @@ -2256,7 +2640,9 @@ public function getTemplatesUri() /** * Sets templates_uri + * * @param string $templates_uri Contains a URI for an endpoint which you can use to retrieve the templates. + * * @return $this */ public function setTemplatesUri($templates_uri) @@ -2268,6 +2654,7 @@ public function setTemplatesUri($templates_uri) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -2277,7 +2664,9 @@ public function getTransactionId() /** * 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) @@ -2289,6 +2678,7 @@ public function setTransactionId($transaction_id) /** * Gets use_disclosure + * * @return string */ public function getUseDisclosure() @@ -2298,7 +2688,9 @@ 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. + * * @return $this */ public function setUseDisclosure($use_disclosure) @@ -2310,6 +2702,7 @@ public function setUseDisclosure($use_disclosure) /** * Gets voided_date_time + * * @return string */ public function getVoidedDateTime() @@ -2319,7 +2712,9 @@ public function getVoidedDateTime() /** * Sets voided_date_time + * * @param string $voided_date_time The date and time the envelope or template was voided. + * * @return $this */ public function setVoidedDateTime($voided_date_time) @@ -2331,6 +2726,7 @@ public function setVoidedDateTime($voided_date_time) /** * Gets voided_reason + * * @return string */ public function getVoidedReason() @@ -2340,7 +2736,9 @@ public function getVoidedReason() /** * Sets voided_reason + * * @param string $voided_reason The reason the envelope or template was voided. + * * @return $this */ public function setVoidedReason($voided_reason) @@ -2351,7 +2749,9 @@ public function setVoidedReason($voided_reason) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2361,7 +2761,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2371,8 +2773,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2386,7 +2790,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2396,16 +2802,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeDocument.php b/src/Model/EnvelopeDocument.php index 0b386d39..afb902ce 100644 --- a/src/Model/EnvelopeDocument.php +++ b/src/Model/EnvelopeDocument.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeDocument Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeDocument implements ArrayAccess +class EnvelopeDocument implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeDocument'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -81,13 +84,63 @@ class EnvelopeDocument implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'added_recipient_ids' => null, + 'attachment_tab_id' => null, + 'authoritative_copy' => null, + 'authoritative_copy_metadata' => null, + 'available_document_types' => null, + 'contains_pdf_form_fields' => null, + 'display' => null, + 'display_metadata' => null, + 'document_fields' => null, + 'document_id' => null, + 'document_id_guid' => null, + 'error_details' => null, + 'include_in_download' => null, + 'include_in_download_metadata' => null, + 'name' => null, + 'name_metadata' => null, + 'order' => null, + 'pages' => null, + 'signer_must_acknowledge' => null, + 'signer_must_acknowledge_metadata' => null, + 'size_bytes' => null, + 'template_locked' => null, + 'template_required' => null, + 'type' => null, + 'uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -118,9 +171,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -151,9 +204,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -184,34 +237,63 @@ public static function swaggerTypes() 'uri' => 'getUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -243,30 +325,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets added_recipient_ids + * * @return string[] */ public function getAddedRecipientIds() @@ -276,7 +360,9 @@ public function getAddedRecipientIds() /** * Sets added_recipient_ids + * * @param string[] $added_recipient_ids + * * @return $this */ public function setAddedRecipientIds($added_recipient_ids) @@ -288,6 +374,7 @@ public function setAddedRecipientIds($added_recipient_ids) /** * Gets attachment_tab_id + * * @return string */ public function getAttachmentTabId() @@ -297,7 +384,9 @@ public function getAttachmentTabId() /** * Sets attachment_tab_id + * * @param string $attachment_tab_id + * * @return $this */ public function setAttachmentTabId($attachment_tab_id) @@ -309,6 +398,7 @@ public function setAttachmentTabId($attachment_tab_id) /** * Gets authoritative_copy + * * @return string */ public function getAuthoritativeCopy() @@ -318,7 +408,9 @@ public function getAuthoritativeCopy() /** * 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) @@ -330,6 +422,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets authoritative_copy_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAuthoritativeCopyMetadata() @@ -339,7 +432,9 @@ public function getAuthoritativeCopyMetadata() /** * Sets authoritative_copy_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $authoritative_copy_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $authoritative_copy_metadata authoritative_copy_metadata + * * @return $this */ public function setAuthoritativeCopyMetadata($authoritative_copy_metadata) @@ -351,6 +446,7 @@ public function setAuthoritativeCopyMetadata($authoritative_copy_metadata) /** * Gets available_document_types + * * @return \DocuSign\eSign\Model\SignatureType[] */ public function getAvailableDocumentTypes() @@ -360,7 +456,9 @@ public function getAvailableDocumentTypes() /** * Sets available_document_types + * * @param \DocuSign\eSign\Model\SignatureType[] $available_document_types + * * @return $this */ public function setAvailableDocumentTypes($available_document_types) @@ -372,6 +470,7 @@ public function setAvailableDocumentTypes($available_document_types) /** * Gets contains_pdf_form_fields + * * @return string */ public function getContainsPdfFormFields() @@ -381,7 +480,9 @@ public function getContainsPdfFormFields() /** * Sets contains_pdf_form_fields + * * @param string $contains_pdf_form_fields + * * @return $this */ public function setContainsPdfFormFields($contains_pdf_form_fields) @@ -393,6 +494,7 @@ public function setContainsPdfFormFields($contains_pdf_form_fields) /** * Gets display + * * @return string */ public function getDisplay() @@ -402,7 +504,9 @@ public function getDisplay() /** * Sets display + * * @param string $display + * * @return $this */ public function setDisplay($display) @@ -414,6 +518,7 @@ public function setDisplay($display) /** * Gets display_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisplayMetadata() @@ -423,7 +528,9 @@ public function getDisplayMetadata() /** * Sets display_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $display_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $display_metadata display_metadata + * * @return $this */ public function setDisplayMetadata($display_metadata) @@ -435,6 +542,7 @@ public function setDisplayMetadata($display_metadata) /** * Gets document_fields + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getDocumentFields() @@ -444,7 +552,9 @@ public function getDocumentFields() /** * Sets document_fields + * * @param \DocuSign\eSign\Model\NameValue[] $document_fields + * * @return $this */ public function setDocumentFields($document_fields) @@ -456,6 +566,7 @@ public function setDocumentFields($document_fields) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -465,7 +576,9 @@ public function getDocumentId() /** * 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) @@ -477,6 +590,7 @@ public function setDocumentId($document_id) /** * Gets document_id_guid + * * @return string */ public function getDocumentIdGuid() @@ -486,7 +600,9 @@ public function getDocumentIdGuid() /** * Sets document_id_guid + * * @param string $document_id_guid + * * @return $this */ public function setDocumentIdGuid($document_id_guid) @@ -498,6 +614,7 @@ public function setDocumentIdGuid($document_id_guid) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -507,7 +624,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -519,6 +638,7 @@ public function setErrorDetails($error_details) /** * Gets include_in_download + * * @return string */ public function getIncludeInDownload() @@ -528,7 +648,9 @@ public function getIncludeInDownload() /** * Sets include_in_download + * * @param string $include_in_download + * * @return $this */ public function setIncludeInDownload($include_in_download) @@ -540,6 +662,7 @@ public function setIncludeInDownload($include_in_download) /** * Gets include_in_download_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIncludeInDownloadMetadata() @@ -549,7 +672,9 @@ public function getIncludeInDownloadMetadata() /** * Sets include_in_download_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $include_in_download_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $include_in_download_metadata include_in_download_metadata + * * @return $this */ public function setIncludeInDownloadMetadata($include_in_download_metadata) @@ -561,6 +686,7 @@ public function setIncludeInDownloadMetadata($include_in_download_metadata) /** * Gets name + * * @return string */ public function getName() @@ -570,7 +696,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -582,6 +710,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -591,7 +720,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -603,6 +734,7 @@ public function setNameMetadata($name_metadata) /** * Gets order + * * @return string */ public function getOrder() @@ -612,7 +744,9 @@ public function getOrder() /** * Sets order + * * @param string $order + * * @return $this */ public function setOrder($order) @@ -624,6 +758,7 @@ public function setOrder($order) /** * Gets pages + * * @return \DocuSign\eSign\Model\Page[] */ public function getPages() @@ -633,7 +768,9 @@ public function getPages() /** * Sets pages + * * @param \DocuSign\eSign\Model\Page[] $pages + * * @return $this */ public function setPages($pages) @@ -645,6 +782,7 @@ public function setPages($pages) /** * Gets signer_must_acknowledge + * * @return string */ public function getSignerMustAcknowledge() @@ -654,7 +792,9 @@ public function getSignerMustAcknowledge() /** * Sets signer_must_acknowledge + * * @param string $signer_must_acknowledge + * * @return $this */ public function setSignerMustAcknowledge($signer_must_acknowledge) @@ -666,6 +806,7 @@ public function setSignerMustAcknowledge($signer_must_acknowledge) /** * Gets signer_must_acknowledge_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignerMustAcknowledgeMetadata() @@ -675,7 +816,9 @@ public function getSignerMustAcknowledgeMetadata() /** * Sets signer_must_acknowledge_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signer_must_acknowledge_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signer_must_acknowledge_metadata signer_must_acknowledge_metadata + * * @return $this */ public function setSignerMustAcknowledgeMetadata($signer_must_acknowledge_metadata) @@ -687,6 +830,7 @@ public function setSignerMustAcknowledgeMetadata($signer_must_acknowledge_metada /** * Gets size_bytes + * * @return string */ public function getSizeBytes() @@ -696,7 +840,9 @@ public function getSizeBytes() /** * Sets size_bytes + * * @param string $size_bytes + * * @return $this */ public function setSizeBytes($size_bytes) @@ -708,6 +854,7 @@ public function setSizeBytes($size_bytes) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -717,7 +864,9 @@ public function getTemplateLocked() /** * 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) @@ -729,6 +878,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -738,7 +888,9 @@ public function getTemplateRequired() /** * 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) @@ -750,6 +902,7 @@ public function setTemplateRequired($template_required) /** * Gets type + * * @return string */ public function getType() @@ -759,7 +912,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -771,6 +926,7 @@ public function setType($type) /** * Gets uri + * * @return string */ public function getUri() @@ -780,7 +936,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -791,7 +949,9 @@ public function setUri($uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -801,7 +961,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -811,8 +973,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -826,7 +990,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -836,16 +1002,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeDocumentsResult.php b/src/Model/EnvelopeDocumentsResult.php index 9c155122..78b4991e 100644 --- a/src/Model/EnvelopeDocumentsResult.php +++ b/src/Model/EnvelopeDocumentsResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeDocumentsResult Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeDocumentsResult implements ArrayAccess +class EnvelopeDocumentsResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeDocumentsResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class EnvelopeDocumentsResult implements ArrayAccess 'envelope_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_documents' => null, + 'envelope_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'envelope_id' => 'envelopeId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'envelope_id' => 'setEnvelopeId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'envelope_id' => 'getEnvelopeId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_documents + * * @return \DocuSign\eSign\Model\EnvelopeDocument[] */ public function getEnvelopeDocuments() @@ -161,7 +222,9 @@ public function getEnvelopeDocuments() /** * Sets envelope_documents + * * @param \DocuSign\eSign\Model\EnvelopeDocument[] $envelope_documents + * * @return $this */ public function setEnvelopeDocuments($envelope_documents) @@ -173,6 +236,7 @@ public function setEnvelopeDocuments($envelope_documents) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -182,7 +246,9 @@ public function getEnvelopeId() /** * 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) @@ -193,7 +259,9 @@ public function setEnvelopeId($envelope_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeEvent.php b/src/Model/EnvelopeEvent.php index 1cbc7a4b..66836184 100644 --- a/src/Model/EnvelopeEvent.php +++ b/src/Model/EnvelopeEvent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeEvent Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeEvent implements ArrayAccess +class EnvelopeEvent implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeEvent'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class EnvelopeEvent implements ArrayAccess 'include_documents' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_event_status_code' => null, + 'include_documents' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'include_documents' => 'includeDocuments' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'include_documents' => 'setIncludeDocuments' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'include_documents' => 'getIncludeDocuments' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_event_status_code + * * @return string */ public function getEnvelopeEventStatusCode() @@ -161,7 +222,9 @@ public function getEnvelopeEventStatusCode() /** * Sets envelope_event_status_code + * * @param string $envelope_event_status_code he envelope status, this can be Sent, Delivered, Completed, Declined, or Voided. + * * @return $this */ public function setEnvelopeEventStatusCode($envelope_event_status_code) @@ -173,6 +236,7 @@ public function setEnvelopeEventStatusCode($envelope_event_status_code) /** * Gets include_documents + * * @return string */ public function getIncludeDocuments() @@ -182,7 +246,9 @@ public function getIncludeDocuments() /** * Sets include_documents + * * @param string $include_documents When set to **true**, the PDF documents are included in the message along with the updated XML. + * * @return $this */ public function setIncludeDocuments($include_documents) @@ -193,7 +259,9 @@ public function setIncludeDocuments($include_documents) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeFormData.php b/src/Model/EnvelopeFormData.php index 2551cdb0..f3962f0b 100644 --- a/src/Model/EnvelopeFormData.php +++ b/src/Model/EnvelopeFormData.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeFormData Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeFormData implements ArrayAccess +class EnvelopeFormData implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeFormData'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class EnvelopeFormData implements ArrayAccess 'status' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'email_subject' => null, + 'envelope_id' => null, + 'form_data' => null, + 'recipient_form_data' => null, + 'sent_date_time' => null, + 'status' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'status' => 'status' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'status' => 'setStatus' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'status' => 'getStatus' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -181,7 +246,9 @@ public function getEmailSubject() /** * Sets email_subject + * * @param string $email_subject Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. + * * @return $this */ public function setEmailSubject($email_subject) @@ -193,6 +260,7 @@ public function setEmailSubject($email_subject) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -202,7 +270,9 @@ public function getEnvelopeId() /** * 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) @@ -214,6 +284,7 @@ public function setEnvelopeId($envelope_id) /** * Gets form_data + * * @return \DocuSign\eSign\Model\FormDataItem[] */ public function getFormData() @@ -223,7 +294,9 @@ public function getFormData() /** * Sets form_data + * * @param \DocuSign\eSign\Model\FormDataItem[] $form_data + * * @return $this */ public function setFormData($form_data) @@ -235,6 +308,7 @@ public function setFormData($form_data) /** * Gets recipient_form_data + * * @return \DocuSign\eSign\Model\RecipientFormData[] */ public function getRecipientFormData() @@ -244,7 +318,9 @@ public function getRecipientFormData() /** * Sets recipient_form_data + * * @param \DocuSign\eSign\Model\RecipientFormData[] $recipient_form_data + * * @return $this */ public function setRecipientFormData($recipient_form_data) @@ -256,6 +332,7 @@ public function setRecipientFormData($recipient_form_data) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -265,7 +342,9 @@ public function getSentDateTime() /** * 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) @@ -277,6 +356,7 @@ public function setSentDateTime($sent_date_time) /** * Gets status + * * @return string */ public function getStatus() @@ -286,7 +366,9 @@ public function getStatus() /** * 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) @@ -297,7 +379,9 @@ public function setStatus($status) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeId.php b/src/Model/EnvelopeId.php index 437caa60..4fc38885 100644 --- a/src/Model/EnvelopeId.php +++ b/src/Model/EnvelopeId.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeId Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeId implements ArrayAccess +class EnvelopeId implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeId'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -141,13 +144,123 @@ class EnvelopeId implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -238,9 +351,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -331,9 +444,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -424,34 +537,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -543,30 +685,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -576,7 +720,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -588,6 +734,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -597,7 +744,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -609,6 +758,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -618,7 +768,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -630,6 +782,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -639,7 +792,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -651,6 +806,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -660,7 +816,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -672,6 +830,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -681,7 +840,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -693,6 +854,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -702,7 +864,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -714,6 +878,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -723,7 +888,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -735,6 +902,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -744,7 +912,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -756,6 +926,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -765,7 +936,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -777,6 +950,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -786,7 +960,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -798,6 +974,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -807,7 +984,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -819,6 +998,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -828,7 +1008,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -840,6 +1022,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -849,7 +1032,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -861,6 +1046,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -870,7 +1056,9 @@ public function getAnchorUnits() /** * 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) @@ -882,6 +1070,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -891,7 +1080,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -903,6 +1094,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -912,7 +1104,9 @@ public function getAnchorXOffset() /** * 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) @@ -924,6 +1118,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -933,7 +1128,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -945,6 +1142,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -954,7 +1152,9 @@ public function getAnchorYOffset() /** * 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) @@ -966,6 +1166,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -975,7 +1176,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -987,6 +1190,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -996,7 +1200,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1008,6 +1214,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1017,7 +1224,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1029,6 +1238,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1038,7 +1248,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1050,6 +1262,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1059,7 +1272,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1071,6 +1286,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1080,7 +1296,9 @@ public function getConditionalParentValue() /** * 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) @@ -1092,6 +1310,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1101,7 +1320,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1113,6 +1334,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1122,7 +1344,9 @@ public function getCustomTabId() /** * 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) @@ -1134,6 +1358,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1143,7 +1368,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1155,6 +1382,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1164,7 +1392,9 @@ public function getDocumentId() /** * 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) @@ -1176,6 +1406,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1185,7 +1416,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1197,6 +1430,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1206,7 +1440,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1218,6 +1454,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1227,7 +1464,9 @@ public function getFont() /** * 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) @@ -1239,6 +1478,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1248,7 +1488,9 @@ public function getFontColor() /** * 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) @@ -1260,6 +1502,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1269,7 +1512,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1281,6 +1526,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1290,7 +1536,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1302,6 +1550,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1311,7 +1560,9 @@ public function getFontSize() /** * 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) @@ -1323,6 +1574,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1332,7 +1584,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1344,6 +1598,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1353,7 +1608,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1365,6 +1622,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1374,7 +1632,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1386,6 +1646,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1395,7 +1656,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1407,6 +1670,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1416,7 +1680,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1428,6 +1694,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1437,7 +1704,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1449,6 +1718,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1458,7 +1728,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1470,6 +1742,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1479,7 +1752,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1491,6 +1766,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1500,7 +1776,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1512,6 +1790,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1521,7 +1800,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1533,6 +1814,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1542,7 +1824,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1554,6 +1838,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1563,7 +1848,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1575,6 +1862,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1584,7 +1872,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1596,6 +1886,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1605,7 +1896,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1617,6 +1910,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1626,7 +1920,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1638,6 +1934,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1647,7 +1944,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1659,6 +1958,7 @@ public function setNameMetadata($name_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1668,7 +1968,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1680,6 +1982,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1689,7 +1992,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1701,6 +2006,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1710,7 +2016,9 @@ public function getRecipientId() /** * 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) @@ -1722,6 +2030,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1731,7 +2040,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1743,6 +2054,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1752,7 +2064,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1764,6 +2078,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1773,7 +2088,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1785,6 +2102,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1794,7 +2112,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1806,6 +2126,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1815,7 +2136,9 @@ public function getStatus() /** * 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) @@ -1827,6 +2150,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1836,7 +2160,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1848,6 +2174,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1857,7 +2184,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1869,6 +2198,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1878,7 +2208,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1890,6 +2222,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1899,7 +2232,9 @@ public function getTabId() /** * 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) @@ -1911,6 +2246,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1920,7 +2256,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1932,6 +2270,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1941,7 +2280,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1953,6 +2294,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1962,7 +2304,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1974,6 +2318,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1983,7 +2328,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1995,6 +2342,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2004,7 +2352,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2016,6 +2366,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2025,7 +2376,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2037,6 +2390,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2046,7 +2400,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2058,6 +2414,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2067,7 +2424,9 @@ public function getTemplateLocked() /** * 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) @@ -2079,6 +2438,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2088,7 +2448,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2100,6 +2462,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2109,7 +2472,9 @@ public function getTemplateRequired() /** * 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) @@ -2121,6 +2486,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2130,7 +2496,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2142,6 +2510,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2151,7 +2520,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2163,6 +2534,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2172,7 +2544,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2184,6 +2558,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2193,7 +2568,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2205,6 +2582,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2214,7 +2592,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2226,6 +2606,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2235,7 +2616,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2247,6 +2630,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2256,7 +2640,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2268,6 +2654,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2277,7 +2664,9 @@ public function getXPosition() /** * 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) @@ -2289,6 +2678,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2298,7 +2688,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2310,6 +2702,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2319,7 +2712,9 @@ public function getYPosition() /** * 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) @@ -2331,6 +2726,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2340,7 +2736,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2351,7 +2749,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2361,7 +2761,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2371,8 +2773,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2386,7 +2790,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2396,16 +2802,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeIdsRequest.php b/src/Model/EnvelopeIdsRequest.php index 85b4751c..2717b7d0 100644 --- a/src/Model/EnvelopeIdsRequest.php +++ b/src/Model/EnvelopeIdsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeIdsRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeIdsRequest implements ArrayAccess +class EnvelopeIdsRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeIdsRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class EnvelopeIdsRequest implements ArrayAccess 'transaction_ids' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_ids' => null, + 'transaction_ids' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'transaction_ids' => 'transactionIds' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'transaction_ids' => 'setTransactionIds' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'transaction_ids' => 'getTransactionIds' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_ids + * * @return string[] */ public function getEnvelopeIds() @@ -161,7 +222,9 @@ public function getEnvelopeIds() /** * Sets envelope_ids + * * @param string[] $envelope_ids + * * @return $this */ public function setEnvelopeIds($envelope_ids) @@ -173,6 +236,7 @@ public function setEnvelopeIds($envelope_ids) /** * Gets transaction_ids + * * @return string[] */ public function getTransactionIds() @@ -182,7 +246,9 @@ public function getTransactionIds() /** * Sets transaction_ids + * * @param string[] $transaction_ids A list of transaction Id's used to determining the status of envelopes sent asynchronously. See **transactionId** property on envelopes. + * * @return $this */ public function setTransactionIds($transaction_ids) @@ -193,7 +259,9 @@ public function setTransactionIds($transaction_ids) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeMetadata.php b/src/Model/EnvelopeMetadata.php index 4dc2e696..67497a33 100644 --- a/src/Model/EnvelopeMetadata.php +++ b/src/Model/EnvelopeMetadata.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeMetadata Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeMetadata implements ArrayAccess +class EnvelopeMetadata implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeMetadata'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class EnvelopeMetadata implements ArrayAccess 'enable_sign_with_notary' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_advanced_correct' => null, + 'allow_correct' => null, + 'enable_sign_with_notary' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'enable_sign_with_notary' => 'enableSignWithNotary' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'enable_sign_with_notary' => 'setEnableSignWithNotary' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'enable_sign_with_notary' => 'getEnableSignWithNotary' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allow_advanced_correct + * * @return string */ public function getAllowAdvancedCorrect() @@ -166,7 +228,9 @@ public function getAllowAdvancedCorrect() /** * Sets allow_advanced_correct + * * @param string $allow_advanced_correct + * * @return $this */ public function setAllowAdvancedCorrect($allow_advanced_correct) @@ -178,6 +242,7 @@ public function setAllowAdvancedCorrect($allow_advanced_correct) /** * Gets allow_correct + * * @return string */ public function getAllowCorrect() @@ -187,7 +252,9 @@ public function getAllowCorrect() /** * Sets allow_correct + * * @param string $allow_correct + * * @return $this */ public function setAllowCorrect($allow_correct) @@ -199,6 +266,7 @@ public function setAllowCorrect($allow_correct) /** * Gets enable_sign_with_notary + * * @return string */ public function getEnableSignWithNotary() @@ -208,7 +276,9 @@ public function getEnableSignWithNotary() /** * Sets enable_sign_with_notary + * * @param string $enable_sign_with_notary + * * @return $this */ public function setEnableSignWithNotary($enable_sign_with_notary) @@ -219,7 +289,9 @@ public function setEnableSignWithNotary($enable_sign_with_notary) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeNotificationRequest.php b/src/Model/EnvelopeNotificationRequest.php index 28ab446e..c3a2faf7 100644 --- a/src/Model/EnvelopeNotificationRequest.php +++ b/src/Model/EnvelopeNotificationRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeNotificationRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeNotificationRequest implements ArrayAccess +class EnvelopeNotificationRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeNotificationRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class EnvelopeNotificationRequest implements ArrayAccess 'use_account_defaults' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'expirations' => null, + 'reminders' => null, + 'use_account_defaults' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'use_account_defaults' => 'useAccountDefaults' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'use_account_defaults' => 'setUseAccountDefaults' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'use_account_defaults' => 'getUseAccountDefaults' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets expirations + * * @return \DocuSign\eSign\Model\Expirations */ public function getExpirations() @@ -166,7 +228,9 @@ public function getExpirations() /** * Sets expirations - * @param \DocuSign\eSign\Model\Expirations $expirations + * + * @param \DocuSign\eSign\Model\Expirations $expirations expirations + * * @return $this */ public function setExpirations($expirations) @@ -178,6 +242,7 @@ public function setExpirations($expirations) /** * Gets reminders + * * @return \DocuSign\eSign\Model\Reminders */ public function getReminders() @@ -187,7 +252,9 @@ public function getReminders() /** * Sets reminders - * @param \DocuSign\eSign\Model\Reminders $reminders + * + * @param \DocuSign\eSign\Model\Reminders $reminders reminders + * * @return $this */ public function setReminders($reminders) @@ -199,6 +266,7 @@ public function setReminders($reminders) /** * Gets use_account_defaults + * * @return string */ public function getUseAccountDefaults() @@ -208,7 +276,9 @@ public function getUseAccountDefaults() /** * Sets use_account_defaults + * * @param string $use_account_defaults + * * @return $this */ public function setUseAccountDefaults($use_account_defaults) @@ -219,7 +289,9 @@ public function setUseAccountDefaults($use_account_defaults) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopePurgeConfiguration.php b/src/Model/EnvelopePurgeConfiguration.php index 68851b00..a83cf43c 100644 --- a/src/Model/EnvelopePurgeConfiguration.php +++ b/src/Model/EnvelopePurgeConfiguration.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopePurgeConfiguration Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopePurgeConfiguration implements ArrayAccess +class EnvelopePurgeConfiguration implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopePurgeConfiguration'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class EnvelopePurgeConfiguration implements ArrayAccess 'retention_days' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'purge_envelopes' => null, + 'redact_pii' => null, + 'remove_tabs_and_envelope_attachments' => null, + 'retention_days' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'retention_days' => 'retentionDays' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'retention_days' => 'setRetentionDays' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'retention_days' => 'getRetentionDays' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets purge_envelopes + * * @return string */ public function getPurgeEnvelopes() @@ -171,7 +234,9 @@ public function getPurgeEnvelopes() /** * Sets purge_envelopes + * * @param string $purge_envelopes + * * @return $this */ public function setPurgeEnvelopes($purge_envelopes) @@ -183,6 +248,7 @@ public function setPurgeEnvelopes($purge_envelopes) /** * Gets redact_pii + * * @return string */ public function getRedactPii() @@ -192,7 +258,9 @@ public function getRedactPii() /** * Sets redact_pii + * * @param string $redact_pii + * * @return $this */ public function setRedactPii($redact_pii) @@ -204,6 +272,7 @@ public function setRedactPii($redact_pii) /** * Gets remove_tabs_and_envelope_attachments + * * @return string */ public function getRemoveTabsAndEnvelopeAttachments() @@ -213,7 +282,9 @@ public function getRemoveTabsAndEnvelopeAttachments() /** * Sets remove_tabs_and_envelope_attachments + * * @param string $remove_tabs_and_envelope_attachments + * * @return $this */ public function setRemoveTabsAndEnvelopeAttachments($remove_tabs_and_envelope_attachments) @@ -225,6 +296,7 @@ public function setRemoveTabsAndEnvelopeAttachments($remove_tabs_and_envelope_at /** * Gets retention_days + * * @return string */ public function getRetentionDays() @@ -234,7 +306,9 @@ public function getRetentionDays() /** * Sets retention_days + * * @param string $retention_days + * * @return $this */ public function setRetentionDays($retention_days) @@ -245,7 +319,9 @@ public function setRetentionDays($retention_days) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeSummary.php b/src/Model/EnvelopeSummary.php index c20e48aa..02592dbb 100644 --- a/src/Model/EnvelopeSummary.php +++ b/src/Model/EnvelopeSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeSummary Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeSummary implements ArrayAccess +class EnvelopeSummary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeSummary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class EnvelopeSummary implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_envelope_status' => null, + 'envelope_id' => null, + 'error_details' => null, + 'status' => null, + 'status_date_time' => null, + 'uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'uri' => 'getUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_envelope_status + * * @return \DocuSign\eSign\Model\BulkEnvelopeStatus */ public function getBulkEnvelopeStatus() @@ -181,7 +246,9 @@ public function getBulkEnvelopeStatus() /** * Sets bulk_envelope_status - * @param \DocuSign\eSign\Model\BulkEnvelopeStatus $bulk_envelope_status + * + * @param \DocuSign\eSign\Model\BulkEnvelopeStatus $bulk_envelope_status bulk_envelope_status + * * @return $this */ public function setBulkEnvelopeStatus($bulk_envelope_status) @@ -193,6 +260,7 @@ public function setBulkEnvelopeStatus($bulk_envelope_status) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -202,7 +270,9 @@ public function getEnvelopeId() /** * 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) @@ -214,6 +284,7 @@ public function setEnvelopeId($envelope_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -223,7 +294,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -235,6 +308,7 @@ public function setErrorDetails($error_details) /** * Gets status + * * @return string */ public function getStatus() @@ -244,7 +318,9 @@ public function getStatus() /** * 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) @@ -256,6 +332,7 @@ public function setStatus($status) /** * Gets status_date_time + * * @return string */ public function getStatusDateTime() @@ -265,7 +342,9 @@ public function getStatusDateTime() /** * Sets status_date_time + * * @param string $status_date_time The DateTime that the envelope changed status (i.e. was created or sent.) + * * @return $this */ public function setStatusDateTime($status_date_time) @@ -277,6 +356,7 @@ public function setStatusDateTime($status_date_time) /** * Gets uri + * * @return string */ public function getUri() @@ -286,7 +366,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -297,7 +379,9 @@ public function setUri($uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeTemplate.php b/src/Model/EnvelopeTemplate.php index b7d250a8..58ffebf6 100644 --- a/src/Model/EnvelopeTemplate.php +++ b/src/Model/EnvelopeTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeTemplate Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeTemplate implements ArrayAccess +class EnvelopeTemplate implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeTemplate'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -153,13 +156,135 @@ class EnvelopeTemplate implements ArrayAccess 'voided_reason' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_control_list_base64' => null, + 'allow_comments' => null, + 'allow_markup' => null, + 'allow_reassign' => null, + 'allow_view_history' => null, + 'any_signer' => null, + 'asynchronous' => null, + 'attachments_uri' => null, + 'authoritative_copy' => null, + 'authoritative_copy_default' => null, + 'auto_match' => null, + 'auto_match_specified_by_user' => null, + 'auto_navigation' => null, + 'brand_id' => null, + 'brand_lock' => null, + 'certificate_uri' => null, + 'completed_date_time' => null, + 'copy_recipient_data' => null, + 'created' => null, + 'created_date_time' => null, + 'custom_fields' => null, + 'custom_fields_uri' => null, + 'declined_date_time' => null, + 'deleted_date_time' => null, + 'delivered_date_time' => null, + 'description' => null, + 'disable_responsive_document' => null, + 'documents' => null, + 'documents_combined_uri' => null, + 'documents_uri' => null, + 'email_blurb' => null, + 'email_settings' => null, + 'email_subject' => null, + 'enable_wet_sign' => null, + 'enforce_signer_visibility' => null, + 'envelope_attachments' => null, + 'envelope_documents' => null, + 'envelope_id' => null, + 'envelope_id_stamping' => null, + 'envelope_location' => null, + 'envelope_metadata' => null, + 'envelope_uri' => null, + 'expire_after' => null, + 'expire_date_time' => null, + 'expire_enabled' => null, + 'external_envelope_id' => null, + 'favorited_by_me' => null, + 'folder_id' => null, + 'folder_ids' => null, + 'folder_name' => null, + 'folders' => null, + 'has_comments' => null, + 'has_form_data_changed' => null, + 'has_wav_file' => null, + 'holder' => null, + 'initial_sent_date_time' => null, + 'is21_cfr_part11' => null, + 'is_dynamic_envelope' => null, + 'is_signature_provider_envelope' => null, + 'last_modified' => null, + 'last_modified_by' => null, + 'last_modified_date_time' => null, + 'last_used' => null, + 'location' => null, + 'lock_information' => null, + 'message_lock' => null, + 'name' => null, + 'new_password' => null, + 'notification' => null, + 'notification_uri' => null, + 'owner' => null, + 'page_count' => null, + 'password' => null, + 'password_protected' => null, + 'power_form' => null, + 'power_forms' => null, + 'purge_completed_date' => null, + 'purge_request_date' => null, + 'purge_state' => null, + 'recipients' => null, + 'recipients_lock' => null, + 'recipients_uri' => null, + 'sender' => null, + 'sent_date_time' => null, + 'shared' => null, + 'signer_can_sign_on_mobile' => null, + 'signing_location' => null, + 'status' => null, + 'status_changed_date_time' => null, + 'status_date_time' => null, + 'template_id' => null, + 'templates_uri' => null, + 'transaction_id' => null, + 'uri' => null, + 'use_disclosure' => null, + 'voided_date_time' => null, + 'voided_reason' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -262,9 +387,9 @@ public static function swaggerTypes() 'voided_reason' => 'voidedReason' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -367,9 +492,9 @@ public static function swaggerTypes() 'voided_reason' => 'setVoidedReason' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -472,34 +597,63 @@ public static function swaggerTypes() 'voided_reason' => 'getVoidedReason' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -603,30 +757,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_control_list_base64 + * * @return string */ public function getAccessControlListBase64() @@ -636,7 +792,9 @@ public function getAccessControlListBase64() /** * Sets access_control_list_base64 + * * @param string $access_control_list_base64 + * * @return $this */ public function setAccessControlListBase64($access_control_list_base64) @@ -648,6 +806,7 @@ public function setAccessControlListBase64($access_control_list_base64) /** * Gets allow_comments + * * @return string */ public function getAllowComments() @@ -657,7 +816,9 @@ public function getAllowComments() /** * Sets allow_comments + * * @param string $allow_comments + * * @return $this */ public function setAllowComments($allow_comments) @@ -669,6 +830,7 @@ public function setAllowComments($allow_comments) /** * Gets allow_markup + * * @return string */ public function getAllowMarkup() @@ -678,7 +840,9 @@ public function getAllowMarkup() /** * Sets allow_markup + * * @param string $allow_markup When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this + * * @return $this */ public function setAllowMarkup($allow_markup) @@ -690,6 +854,7 @@ public function setAllowMarkup($allow_markup) /** * Gets allow_reassign + * * @return string */ public function getAllowReassign() @@ -699,7 +864,9 @@ public function getAllowReassign() /** * Sets allow_reassign + * * @param string $allow_reassign When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. + * * @return $this */ public function setAllowReassign($allow_reassign) @@ -711,6 +878,7 @@ public function setAllowReassign($allow_reassign) /** * Gets allow_view_history + * * @return string */ public function getAllowViewHistory() @@ -720,7 +888,9 @@ public function getAllowViewHistory() /** * Sets allow_view_history + * * @param string $allow_view_history + * * @return $this */ public function setAllowViewHistory($allow_view_history) @@ -732,6 +902,7 @@ public function setAllowViewHistory($allow_view_history) /** * Gets any_signer + * * @return string */ public function getAnySigner() @@ -741,7 +912,9 @@ public function getAnySigner() /** * Sets any_signer + * * @param string $any_signer + * * @return $this */ public function setAnySigner($any_signer) @@ -753,6 +926,7 @@ public function setAnySigner($any_signer) /** * Gets asynchronous + * * @return string */ public function getAsynchronous() @@ -762,7 +936,9 @@ public function getAsynchronous() /** * Sets asynchronous + * * @param string $asynchronous When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. + * * @return $this */ public function setAsynchronous($asynchronous) @@ -774,6 +950,7 @@ public function setAsynchronous($asynchronous) /** * Gets attachments_uri + * * @return string */ public function getAttachmentsUri() @@ -783,7 +960,9 @@ public function getAttachmentsUri() /** * Sets attachments_uri + * * @param string $attachments_uri + * * @return $this */ public function setAttachmentsUri($attachments_uri) @@ -795,6 +974,7 @@ public function setAttachmentsUri($attachments_uri) /** * Gets authoritative_copy + * * @return string */ public function getAuthoritativeCopy() @@ -804,7 +984,9 @@ public function getAuthoritativeCopy() /** * 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) @@ -816,6 +998,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets authoritative_copy_default + * * @return string */ public function getAuthoritativeCopyDefault() @@ -825,7 +1008,9 @@ public function getAuthoritativeCopyDefault() /** * Sets authoritative_copy_default + * * @param string $authoritative_copy_default + * * @return $this */ public function setAuthoritativeCopyDefault($authoritative_copy_default) @@ -837,6 +1022,7 @@ public function setAuthoritativeCopyDefault($authoritative_copy_default) /** * Gets auto_match + * * @return string */ public function getAutoMatch() @@ -846,7 +1032,9 @@ public function getAutoMatch() /** * Sets auto_match + * * @param string $auto_match + * * @return $this */ public function setAutoMatch($auto_match) @@ -858,6 +1046,7 @@ public function setAutoMatch($auto_match) /** * Gets auto_match_specified_by_user + * * @return string */ public function getAutoMatchSpecifiedByUser() @@ -867,7 +1056,9 @@ public function getAutoMatchSpecifiedByUser() /** * Sets auto_match_specified_by_user + * * @param string $auto_match_specified_by_user + * * @return $this */ public function setAutoMatchSpecifiedByUser($auto_match_specified_by_user) @@ -879,6 +1070,7 @@ public function setAutoMatchSpecifiedByUser($auto_match_specified_by_user) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -888,7 +1080,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -900,6 +1094,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -909,7 +1104,9 @@ public function getBrandId() /** * Sets brand_id + * * @param string $brand_id + * * @return $this */ public function setBrandId($brand_id) @@ -921,6 +1118,7 @@ public function setBrandId($brand_id) /** * Gets brand_lock + * * @return string */ public function getBrandLock() @@ -930,7 +1128,9 @@ public function getBrandLock() /** * Sets brand_lock + * * @param string $brand_lock + * * @return $this */ public function setBrandLock($brand_lock) @@ -942,6 +1142,7 @@ public function setBrandLock($brand_lock) /** * Gets certificate_uri + * * @return string */ public function getCertificateUri() @@ -951,7 +1152,9 @@ public function getCertificateUri() /** * Sets certificate_uri + * * @param string $certificate_uri Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. + * * @return $this */ public function setCertificateUri($certificate_uri) @@ -963,6 +1166,7 @@ public function setCertificateUri($certificate_uri) /** * Gets completed_date_time + * * @return string */ public function getCompletedDateTime() @@ -972,7 +1176,9 @@ public function getCompletedDateTime() /** * Sets completed_date_time + * * @param string $completed_date_time Specifies the date and time this item was completed. + * * @return $this */ public function setCompletedDateTime($completed_date_time) @@ -984,6 +1190,7 @@ public function setCompletedDateTime($completed_date_time) /** * Gets copy_recipient_data + * * @return string */ public function getCopyRecipientData() @@ -993,7 +1200,9 @@ public function getCopyRecipientData() /** * Sets copy_recipient_data + * * @param string $copy_recipient_data + * * @return $this */ public function setCopyRecipientData($copy_recipient_data) @@ -1005,6 +1214,7 @@ public function setCopyRecipientData($copy_recipient_data) /** * Gets created + * * @return string */ public function getCreated() @@ -1014,7 +1224,9 @@ public function getCreated() /** * Sets created + * * @param string $created + * * @return $this */ public function setCreated($created) @@ -1026,6 +1238,7 @@ public function setCreated($created) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -1035,7 +1248,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -1047,6 +1262,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\CustomFields */ public function getCustomFields() @@ -1056,7 +1272,9 @@ public function getCustomFields() /** * Sets custom_fields - * @param \DocuSign\eSign\Model\CustomFields $custom_fields + * + * @param \DocuSign\eSign\Model\CustomFields $custom_fields custom_fields + * * @return $this */ public function setCustomFields($custom_fields) @@ -1068,6 +1286,7 @@ public function setCustomFields($custom_fields) /** * Gets custom_fields_uri + * * @return string */ public function getCustomFieldsUri() @@ -1077,7 +1296,9 @@ public function getCustomFieldsUri() /** * Sets custom_fields_uri + * * @param string $custom_fields_uri Contains a URI for an endpoint that you can use to retrieve the custom fields. + * * @return $this */ public function setCustomFieldsUri($custom_fields_uri) @@ -1089,6 +1310,7 @@ public function setCustomFieldsUri($custom_fields_uri) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -1098,7 +1320,9 @@ public function getDeclinedDateTime() /** * 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) @@ -1110,6 +1334,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets deleted_date_time + * * @return string */ public function getDeletedDateTime() @@ -1119,7 +1344,9 @@ public function getDeletedDateTime() /** * Sets deleted_date_time + * * @param string $deleted_date_time Specifies the data and time the item was deleted. + * * @return $this */ public function setDeletedDateTime($deleted_date_time) @@ -1131,6 +1358,7 @@ public function setDeletedDateTime($deleted_date_time) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -1140,7 +1368,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -1152,6 +1382,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets description + * * @return string */ public function getDescription() @@ -1161,7 +1392,9 @@ public function getDescription() /** * Sets description + * * @param string $description + * * @return $this */ public function setDescription($description) @@ -1173,6 +1406,7 @@ public function setDescription($description) /** * Gets disable_responsive_document + * * @return string */ public function getDisableResponsiveDocument() @@ -1182,7 +1416,9 @@ public function getDisableResponsiveDocument() /** * Sets disable_responsive_document + * * @param string $disable_responsive_document + * * @return $this */ public function setDisableResponsiveDocument($disable_responsive_document) @@ -1194,6 +1430,7 @@ public function setDisableResponsiveDocument($disable_responsive_document) /** * Gets documents + * * @return \DocuSign\eSign\Model\Document[] */ public function getDocuments() @@ -1203,7 +1440,9 @@ public function getDocuments() /** * Sets documents + * * @param \DocuSign\eSign\Model\Document[] $documents Complex element contains the details on the documents in the envelope. + * * @return $this */ public function setDocuments($documents) @@ -1215,6 +1454,7 @@ public function setDocuments($documents) /** * Gets documents_combined_uri + * * @return string */ public function getDocumentsCombinedUri() @@ -1224,7 +1464,9 @@ public function getDocumentsCombinedUri() /** * Sets documents_combined_uri + * * @param string $documents_combined_uri + * * @return $this */ public function setDocumentsCombinedUri($documents_combined_uri) @@ -1236,6 +1478,7 @@ public function setDocumentsCombinedUri($documents_combined_uri) /** * Gets documents_uri + * * @return string */ public function getDocumentsUri() @@ -1245,7 +1488,9 @@ public function getDocumentsUri() /** * Sets documents_uri + * * @param string $documents_uri Contains a URI for an endpoint that you can use to retrieve the documents. + * * @return $this */ public function setDocumentsUri($documents_uri) @@ -1257,6 +1502,7 @@ public function setDocumentsUri($documents_uri) /** * Gets email_blurb + * * @return string */ public function getEmailBlurb() @@ -1266,7 +1512,9 @@ public function getEmailBlurb() /** * Sets email_blurb + * * @param string $email_blurb + * * @return $this */ public function setEmailBlurb($email_blurb) @@ -1278,6 +1526,7 @@ public function setEmailBlurb($email_blurb) /** * Gets email_settings + * * @return \DocuSign\eSign\Model\EmailSettings */ public function getEmailSettings() @@ -1287,7 +1536,9 @@ public function getEmailSettings() /** * Sets email_settings - * @param \DocuSign\eSign\Model\EmailSettings $email_settings + * + * @param \DocuSign\eSign\Model\EmailSettings $email_settings email_settings + * * @return $this */ public function setEmailSettings($email_settings) @@ -1299,6 +1550,7 @@ public function setEmailSettings($email_settings) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -1308,7 +1560,9 @@ public function getEmailSubject() /** * Sets email_subject + * * @param string $email_subject Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. + * * @return $this */ public function setEmailSubject($email_subject) @@ -1320,6 +1574,7 @@ public function setEmailSubject($email_subject) /** * Gets enable_wet_sign + * * @return string */ public function getEnableWetSign() @@ -1329,7 +1584,9 @@ public function getEnableWetSign() /** * Sets enable_wet_sign + * * @param string $enable_wet_sign When set to **true**, the signer is allowed to print the document and sign it on paper. + * * @return $this */ public function setEnableWetSign($enable_wet_sign) @@ -1341,6 +1598,7 @@ public function setEnableWetSign($enable_wet_sign) /** * Gets enforce_signer_visibility + * * @return string */ public function getEnforceSignerVisibility() @@ -1350,7 +1608,9 @@ public function getEnforceSignerVisibility() /** * Sets enforce_signer_visibility + * * @param string $enforce_signer_visibility When set to **true**, 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. Your account must have Document Visibility enabled to use this. + * * @return $this */ public function setEnforceSignerVisibility($enforce_signer_visibility) @@ -1362,6 +1622,7 @@ public function setEnforceSignerVisibility($enforce_signer_visibility) /** * Gets envelope_attachments + * * @return \DocuSign\eSign\Model\Attachment[] */ public function getEnvelopeAttachments() @@ -1371,7 +1632,9 @@ public function getEnvelopeAttachments() /** * Sets envelope_attachments + * * @param \DocuSign\eSign\Model\Attachment[] $envelope_attachments + * * @return $this */ public function setEnvelopeAttachments($envelope_attachments) @@ -1383,6 +1646,7 @@ public function setEnvelopeAttachments($envelope_attachments) /** * Gets envelope_documents + * * @return \DocuSign\eSign\Model\EnvelopeDocument[] */ public function getEnvelopeDocuments() @@ -1392,7 +1656,9 @@ public function getEnvelopeDocuments() /** * Sets envelope_documents + * * @param \DocuSign\eSign\Model\EnvelopeDocument[] $envelope_documents + * * @return $this */ public function setEnvelopeDocuments($envelope_documents) @@ -1404,6 +1670,7 @@ public function setEnvelopeDocuments($envelope_documents) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -1413,7 +1680,9 @@ public function getEnvelopeId() /** * 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) @@ -1425,6 +1694,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_id_stamping + * * @return string */ public function getEnvelopeIdStamping() @@ -1434,7 +1704,9 @@ public function getEnvelopeIdStamping() /** * Sets envelope_id_stamping + * * @param string $envelope_id_stamping When set to **true**, Envelope ID Stamping is enabled. + * * @return $this */ public function setEnvelopeIdStamping($envelope_id_stamping) @@ -1446,6 +1718,7 @@ public function setEnvelopeIdStamping($envelope_id_stamping) /** * Gets envelope_location + * * @return string */ public function getEnvelopeLocation() @@ -1455,7 +1728,9 @@ public function getEnvelopeLocation() /** * Sets envelope_location + * * @param string $envelope_location + * * @return $this */ public function setEnvelopeLocation($envelope_location) @@ -1467,6 +1742,7 @@ public function setEnvelopeLocation($envelope_location) /** * Gets envelope_metadata + * * @return \DocuSign\eSign\Model\EnvelopeMetadata */ public function getEnvelopeMetadata() @@ -1476,7 +1752,9 @@ public function getEnvelopeMetadata() /** * Sets envelope_metadata - * @param \DocuSign\eSign\Model\EnvelopeMetadata $envelope_metadata + * + * @param \DocuSign\eSign\Model\EnvelopeMetadata $envelope_metadata envelope_metadata + * * @return $this */ public function setEnvelopeMetadata($envelope_metadata) @@ -1488,6 +1766,7 @@ public function setEnvelopeMetadata($envelope_metadata) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -1497,7 +1776,9 @@ public function getEnvelopeUri() /** * Sets envelope_uri + * * @param string $envelope_uri Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. + * * @return $this */ public function setEnvelopeUri($envelope_uri) @@ -1509,6 +1790,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets expire_after + * * @return string */ public function getExpireAfter() @@ -1518,7 +1800,9 @@ public function getExpireAfter() /** * Sets expire_after + * * @param string $expire_after + * * @return $this */ public function setExpireAfter($expire_after) @@ -1530,6 +1814,7 @@ public function setExpireAfter($expire_after) /** * Gets expire_date_time + * * @return string */ public function getExpireDateTime() @@ -1539,7 +1824,9 @@ public function getExpireDateTime() /** * Sets expire_date_time + * * @param string $expire_date_time + * * @return $this */ public function setExpireDateTime($expire_date_time) @@ -1551,6 +1838,7 @@ public function setExpireDateTime($expire_date_time) /** * Gets expire_enabled + * * @return string */ public function getExpireEnabled() @@ -1560,7 +1848,9 @@ public function getExpireEnabled() /** * Sets expire_enabled + * * @param string $expire_enabled + * * @return $this */ public function setExpireEnabled($expire_enabled) @@ -1572,6 +1862,7 @@ public function setExpireEnabled($expire_enabled) /** * Gets external_envelope_id + * * @return string */ public function getExternalEnvelopeId() @@ -1581,7 +1872,9 @@ public function getExternalEnvelopeId() /** * Sets external_envelope_id + * * @param string $external_envelope_id + * * @return $this */ public function setExternalEnvelopeId($external_envelope_id) @@ -1593,6 +1886,7 @@ public function setExternalEnvelopeId($external_envelope_id) /** * Gets favorited_by_me + * * @return string */ public function getFavoritedByMe() @@ -1602,7 +1896,9 @@ public function getFavoritedByMe() /** * Sets favorited_by_me + * * @param string $favorited_by_me + * * @return $this */ public function setFavoritedByMe($favorited_by_me) @@ -1614,6 +1910,7 @@ public function setFavoritedByMe($favorited_by_me) /** * Gets folder_id + * * @return string */ public function getFolderId() @@ -1623,7 +1920,9 @@ public function getFolderId() /** * Sets folder_id + * * @param string $folder_id + * * @return $this */ public function setFolderId($folder_id) @@ -1635,6 +1934,7 @@ public function setFolderId($folder_id) /** * Gets folder_ids + * * @return string[] */ public function getFolderIds() @@ -1644,7 +1944,9 @@ public function getFolderIds() /** * Sets folder_ids + * * @param string[] $folder_ids + * * @return $this */ public function setFolderIds($folder_ids) @@ -1656,6 +1958,7 @@ public function setFolderIds($folder_ids) /** * Gets folder_name + * * @return string */ public function getFolderName() @@ -1665,7 +1968,9 @@ public function getFolderName() /** * Sets folder_name + * * @param string $folder_name + * * @return $this */ public function setFolderName($folder_name) @@ -1677,6 +1982,7 @@ public function setFolderName($folder_name) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -1686,7 +1992,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders + * * @return $this */ public function setFolders($folders) @@ -1698,6 +2006,7 @@ public function setFolders($folders) /** * Gets has_comments + * * @return string */ public function getHasComments() @@ -1707,7 +2016,9 @@ public function getHasComments() /** * Sets has_comments + * * @param string $has_comments + * * @return $this */ public function setHasComments($has_comments) @@ -1719,6 +2030,7 @@ public function setHasComments($has_comments) /** * Gets has_form_data_changed + * * @return string */ public function getHasFormDataChanged() @@ -1728,7 +2040,9 @@ public function getHasFormDataChanged() /** * Sets has_form_data_changed + * * @param string $has_form_data_changed + * * @return $this */ public function setHasFormDataChanged($has_form_data_changed) @@ -1740,6 +2054,7 @@ public function setHasFormDataChanged($has_form_data_changed) /** * Gets has_wav_file + * * @return string */ public function getHasWavFile() @@ -1749,7 +2064,9 @@ public function getHasWavFile() /** * Sets has_wav_file + * * @param string $has_wav_file + * * @return $this */ public function setHasWavFile($has_wav_file) @@ -1761,6 +2078,7 @@ public function setHasWavFile($has_wav_file) /** * Gets holder + * * @return string */ public function getHolder() @@ -1770,7 +2088,9 @@ public function getHolder() /** * Sets holder + * * @param string $holder + * * @return $this */ public function setHolder($holder) @@ -1782,6 +2102,7 @@ public function setHolder($holder) /** * Gets initial_sent_date_time + * * @return string */ public function getInitialSentDateTime() @@ -1791,7 +2112,9 @@ public function getInitialSentDateTime() /** * Sets initial_sent_date_time + * * @param string $initial_sent_date_time + * * @return $this */ public function setInitialSentDateTime($initial_sent_date_time) @@ -1803,6 +2126,7 @@ public function setInitialSentDateTime($initial_sent_date_time) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -1812,7 +2136,9 @@ public function getIs21CfrPart11() /** * Sets is21_cfr_part11 + * * @param string $is21_cfr_part11 When set to **true**, indicates that this module is enabled on the account. + * * @return $this */ public function setIs21CfrPart11($is21_cfr_part11) @@ -1824,6 +2150,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets is_dynamic_envelope + * * @return string */ public function getIsDynamicEnvelope() @@ -1833,7 +2160,9 @@ public function getIsDynamicEnvelope() /** * Sets is_dynamic_envelope + * * @param string $is_dynamic_envelope + * * @return $this */ public function setIsDynamicEnvelope($is_dynamic_envelope) @@ -1845,6 +2174,7 @@ public function setIsDynamicEnvelope($is_dynamic_envelope) /** * Gets is_signature_provider_envelope + * * @return string */ public function getIsSignatureProviderEnvelope() @@ -1854,7 +2184,9 @@ public function getIsSignatureProviderEnvelope() /** * Sets is_signature_provider_envelope + * * @param string $is_signature_provider_envelope + * * @return $this */ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) @@ -1866,6 +2198,7 @@ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -1875,7 +2208,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified + * * @return $this */ public function setLastModified($last_modified) @@ -1887,6 +2222,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_by + * * @return \DocuSign\eSign\Model\UserInfo */ public function getLastModifiedBy() @@ -1896,7 +2232,9 @@ public function getLastModifiedBy() /** * Sets last_modified_by - * @param \DocuSign\eSign\Model\UserInfo $last_modified_by + * + * @param \DocuSign\eSign\Model\UserInfo $last_modified_by last_modified_by + * * @return $this */ public function setLastModifiedBy($last_modified_by) @@ -1908,6 +2246,7 @@ public function setLastModifiedBy($last_modified_by) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -1917,7 +2256,9 @@ public function getLastModifiedDateTime() /** * Sets last_modified_date_time + * * @param string $last_modified_date_time The date and time the item was last modified. + * * @return $this */ public function setLastModifiedDateTime($last_modified_date_time) @@ -1929,6 +2270,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets last_used + * * @return string */ public function getLastUsed() @@ -1938,7 +2280,9 @@ public function getLastUsed() /** * Sets last_used + * * @param string $last_used + * * @return $this */ public function setLastUsed($last_used) @@ -1950,6 +2294,7 @@ public function setLastUsed($last_used) /** * Gets location + * * @return string */ public function getLocation() @@ -1959,7 +2304,9 @@ public function getLocation() /** * Sets location + * * @param string $location + * * @return $this */ public function setLocation($location) @@ -1971,6 +2318,7 @@ public function setLocation($location) /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -1980,7 +2328,9 @@ public function getLockInformation() /** * Sets lock_information - * @param \DocuSign\eSign\Model\LockInformation $lock_information + * + * @param \DocuSign\eSign\Model\LockInformation $lock_information lock_information + * * @return $this */ public function setLockInformation($lock_information) @@ -1992,6 +2342,7 @@ public function setLockInformation($lock_information) /** * Gets message_lock + * * @return string */ public function getMessageLock() @@ -2001,7 +2352,9 @@ public function getMessageLock() /** * Sets message_lock + * * @param string $message_lock When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. + * * @return $this */ public function setMessageLock($message_lock) @@ -2013,6 +2366,7 @@ public function setMessageLock($message_lock) /** * Gets name + * * @return string */ public function getName() @@ -2022,7 +2376,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -2034,6 +2390,7 @@ public function setName($name) /** * Gets new_password + * * @return string */ public function getNewPassword() @@ -2043,7 +2400,9 @@ public function getNewPassword() /** * Sets new_password + * * @param string $new_password + * * @return $this */ public function setNewPassword($new_password) @@ -2055,6 +2414,7 @@ public function setNewPassword($new_password) /** * Gets notification + * * @return \DocuSign\eSign\Model\Notification */ public function getNotification() @@ -2064,7 +2424,9 @@ public function getNotification() /** * Sets notification - * @param \DocuSign\eSign\Model\Notification $notification + * + * @param \DocuSign\eSign\Model\Notification $notification notification + * * @return $this */ public function setNotification($notification) @@ -2076,6 +2438,7 @@ public function setNotification($notification) /** * Gets notification_uri + * * @return string */ public function getNotificationUri() @@ -2085,7 +2448,9 @@ public function getNotificationUri() /** * Sets notification_uri + * * @param string $notification_uri Contains a URI for an endpoint that you can use to retrieve the notifications. + * * @return $this */ public function setNotificationUri($notification_uri) @@ -2097,6 +2462,7 @@ public function setNotificationUri($notification_uri) /** * Gets owner + * * @return \DocuSign\eSign\Model\UserInfo */ public function getOwner() @@ -2106,7 +2472,9 @@ public function getOwner() /** * Sets owner - * @param \DocuSign\eSign\Model\UserInfo $owner + * + * @param \DocuSign\eSign\Model\UserInfo $owner owner + * * @return $this */ public function setOwner($owner) @@ -2118,6 +2486,7 @@ public function setOwner($owner) /** * Gets page_count + * * @return string */ public function getPageCount() @@ -2127,7 +2496,9 @@ public function getPageCount() /** * Sets page_count + * * @param string $page_count + * * @return $this */ public function setPageCount($page_count) @@ -2139,6 +2510,7 @@ public function setPageCount($page_count) /** * Gets password + * * @return string */ public function getPassword() @@ -2148,7 +2520,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -2160,6 +2534,7 @@ public function setPassword($password) /** * Gets password_protected + * * @return string */ public function getPasswordProtected() @@ -2169,7 +2544,9 @@ public function getPasswordProtected() /** * Sets password_protected + * * @param string $password_protected + * * @return $this */ public function setPasswordProtected($password_protected) @@ -2181,6 +2558,7 @@ public function setPasswordProtected($password_protected) /** * Gets power_form + * * @return \DocuSign\eSign\Model\PowerForm */ public function getPowerForm() @@ -2190,7 +2568,9 @@ public function getPowerForm() /** * Sets power_form - * @param \DocuSign\eSign\Model\PowerForm $power_form + * + * @param \DocuSign\eSign\Model\PowerForm $power_form power_form + * * @return $this */ public function setPowerForm($power_form) @@ -2202,6 +2582,7 @@ public function setPowerForm($power_form) /** * Gets power_forms + * * @return \DocuSign\eSign\Model\PowerForm[] */ public function getPowerForms() @@ -2211,7 +2592,9 @@ public function getPowerForms() /** * Sets power_forms + * * @param \DocuSign\eSign\Model\PowerForm[] $power_forms + * * @return $this */ public function setPowerForms($power_forms) @@ -2223,6 +2606,7 @@ public function setPowerForms($power_forms) /** * Gets purge_completed_date + * * @return string */ public function getPurgeCompletedDate() @@ -2232,7 +2616,9 @@ public function getPurgeCompletedDate() /** * Sets purge_completed_date + * * @param string $purge_completed_date + * * @return $this */ public function setPurgeCompletedDate($purge_completed_date) @@ -2244,6 +2630,7 @@ public function setPurgeCompletedDate($purge_completed_date) /** * Gets purge_request_date + * * @return string */ public function getPurgeRequestDate() @@ -2253,7 +2640,9 @@ public function getPurgeRequestDate() /** * Sets purge_request_date + * * @param string $purge_request_date + * * @return $this */ public function setPurgeRequestDate($purge_request_date) @@ -2265,6 +2654,7 @@ public function setPurgeRequestDate($purge_request_date) /** * Gets purge_state + * * @return string */ public function getPurgeState() @@ -2274,7 +2664,9 @@ public function getPurgeState() /** * Sets purge_state + * * @param string $purge_state + * * @return $this */ public function setPurgeState($purge_state) @@ -2286,6 +2678,7 @@ public function setPurgeState($purge_state) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -2295,7 +2688,9 @@ public function getRecipients() /** * Sets recipients - * @param \DocuSign\eSign\Model\Recipients $recipients + * + * @param \DocuSign\eSign\Model\Recipients $recipients recipients + * * @return $this */ public function setRecipients($recipients) @@ -2307,6 +2702,7 @@ public function setRecipients($recipients) /** * Gets recipients_lock + * * @return string */ public function getRecipientsLock() @@ -2316,7 +2712,9 @@ public function getRecipientsLock() /** * Sets recipients_lock + * * @param string $recipients_lock When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. + * * @return $this */ public function setRecipientsLock($recipients_lock) @@ -2328,6 +2726,7 @@ public function setRecipientsLock($recipients_lock) /** * Gets recipients_uri + * * @return string */ public function getRecipientsUri() @@ -2337,7 +2736,9 @@ public function getRecipientsUri() /** * Sets recipients_uri + * * @param string $recipients_uri Contains a URI for an endpoint that you can use to retrieve the recipients. + * * @return $this */ public function setRecipientsUri($recipients_uri) @@ -2349,6 +2750,7 @@ public function setRecipientsUri($recipients_uri) /** * Gets sender + * * @return \DocuSign\eSign\Model\UserInfo */ public function getSender() @@ -2358,7 +2760,9 @@ public function getSender() /** * Sets sender - * @param \DocuSign\eSign\Model\UserInfo $sender + * + * @param \DocuSign\eSign\Model\UserInfo $sender sender + * * @return $this */ public function setSender($sender) @@ -2370,6 +2774,7 @@ public function setSender($sender) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -2379,7 +2784,9 @@ public function getSentDateTime() /** * 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) @@ -2391,6 +2798,7 @@ public function setSentDateTime($sent_date_time) /** * Gets shared + * * @return string */ public function getShared() @@ -2400,7 +2808,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -2412,6 +2822,7 @@ public function setShared($shared) /** * Gets signer_can_sign_on_mobile + * * @return string */ public function getSignerCanSignOnMobile() @@ -2421,7 +2832,9 @@ public function getSignerCanSignOnMobile() /** * Sets signer_can_sign_on_mobile + * * @param string $signer_can_sign_on_mobile + * * @return $this */ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) @@ -2433,6 +2846,7 @@ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) /** * Gets signing_location + * * @return string */ public function getSigningLocation() @@ -2442,7 +2856,9 @@ public function getSigningLocation() /** * 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) @@ -2454,6 +2870,7 @@ public function setSigningLocation($signing_location) /** * Gets status + * * @return string */ public function getStatus() @@ -2463,7 +2880,9 @@ public function getStatus() /** * 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) @@ -2475,6 +2894,7 @@ public function setStatus($status) /** * Gets status_changed_date_time + * * @return string */ public function getStatusChangedDateTime() @@ -2484,7 +2904,9 @@ public function getStatusChangedDateTime() /** * Sets status_changed_date_time + * * @param string $status_changed_date_time The data and time the status changed. + * * @return $this */ public function setStatusChangedDateTime($status_changed_date_time) @@ -2496,6 +2918,7 @@ public function setStatusChangedDateTime($status_changed_date_time) /** * Gets status_date_time + * * @return string */ public function getStatusDateTime() @@ -2505,7 +2928,9 @@ public function getStatusDateTime() /** * Sets status_date_time + * * @param string $status_date_time + * * @return $this */ public function setStatusDateTime($status_date_time) @@ -2517,6 +2942,7 @@ public function setStatusDateTime($status_date_time) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -2526,7 +2952,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -2538,6 +2966,7 @@ public function setTemplateId($template_id) /** * Gets templates_uri + * * @return string */ public function getTemplatesUri() @@ -2547,7 +2976,9 @@ public function getTemplatesUri() /** * Sets templates_uri + * * @param string $templates_uri Contains a URI for an endpoint which you can use to retrieve the templates. + * * @return $this */ public function setTemplatesUri($templates_uri) @@ -2559,6 +2990,7 @@ public function setTemplatesUri($templates_uri) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -2568,7 +3000,9 @@ public function getTransactionId() /** * 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) @@ -2580,6 +3014,7 @@ public function setTransactionId($transaction_id) /** * Gets uri + * * @return string */ public function getUri() @@ -2589,7 +3024,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -2601,6 +3038,7 @@ public function setUri($uri) /** * Gets use_disclosure + * * @return string */ public function getUseDisclosure() @@ -2610,7 +3048,9 @@ 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. + * * @return $this */ public function setUseDisclosure($use_disclosure) @@ -2622,6 +3062,7 @@ public function setUseDisclosure($use_disclosure) /** * Gets voided_date_time + * * @return string */ public function getVoidedDateTime() @@ -2631,7 +3072,9 @@ public function getVoidedDateTime() /** * Sets voided_date_time + * * @param string $voided_date_time The date and time the envelope or template was voided. + * * @return $this */ public function setVoidedDateTime($voided_date_time) @@ -2643,6 +3086,7 @@ public function setVoidedDateTime($voided_date_time) /** * Gets voided_reason + * * @return string */ public function getVoidedReason() @@ -2652,7 +3096,9 @@ public function getVoidedReason() /** * Sets voided_reason + * * @param string $voided_reason The reason the envelope or template was voided. + * * @return $this */ public function setVoidedReason($voided_reason) @@ -2663,7 +3109,9 @@ public function setVoidedReason($voided_reason) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2673,7 +3121,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2683,8 +3133,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2698,7 +3150,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2708,16 +3162,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeTemplateResults.php b/src/Model/EnvelopeTemplateResults.php index e039c5a4..05713f8d 100644 --- a/src/Model/EnvelopeTemplateResults.php +++ b/src/Model/EnvelopeTemplateResults.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeTemplateResults Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeTemplateResults implements ArrayAccess +class EnvelopeTemplateResults implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeTemplateResults'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class EnvelopeTemplateResults implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'envelope_templates' => null, + 'folders' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -191,7 +258,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -203,6 +272,7 @@ public function setEndPosition($end_position) /** * Gets envelope_templates + * * @return \DocuSign\eSign\Model\EnvelopeTemplate[] */ public function getEnvelopeTemplates() @@ -212,7 +282,9 @@ public function getEnvelopeTemplates() /** * Sets envelope_templates + * * @param \DocuSign\eSign\Model\EnvelopeTemplate[] $envelope_templates The list of requested templates. + * * @return $this */ public function setEnvelopeTemplates($envelope_templates) @@ -224,6 +296,7 @@ public function setEnvelopeTemplates($envelope_templates) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -233,7 +306,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders + * * @return $this */ public function setFolders($folders) @@ -245,6 +320,7 @@ public function setFolders($folders) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -254,7 +330,9 @@ public function getNextUri() /** * 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) @@ -266,6 +344,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -275,7 +354,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -287,6 +368,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -296,7 +378,9 @@ public function getResultSetSize() /** * 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) @@ -308,6 +392,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -317,7 +402,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -329,6 +416,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -338,7 +426,9 @@ public function getTotalSetSize() /** * 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) @@ -349,7 +439,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeTransactionStatus.php b/src/Model/EnvelopeTransactionStatus.php index 097f9be9..4528ccb6 100644 --- a/src/Model/EnvelopeTransactionStatus.php +++ b/src/Model/EnvelopeTransactionStatus.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeTransactionStatus Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeTransactionStatus implements ArrayAccess +class EnvelopeTransactionStatus implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeTransactionStatus'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class EnvelopeTransactionStatus implements ArrayAccess 'transaction_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_id' => null, + 'error_details' => null, + 'status' => null, + 'transaction_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'transaction_id' => 'transactionId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'transaction_id' => 'setTransactionId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'transaction_id' => 'getTransactionId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -171,7 +234,9 @@ public function getEnvelopeId() /** * 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) @@ -183,6 +248,7 @@ public function setEnvelopeId($envelope_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -192,7 +258,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -204,6 +272,7 @@ public function setErrorDetails($error_details) /** * Gets status + * * @return string */ public function getStatus() @@ -213,7 +282,9 @@ public function getStatus() /** * 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) @@ -225,6 +296,7 @@ public function setStatus($status) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -234,7 +306,9 @@ public function getTransactionId() /** * 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) @@ -245,7 +319,9 @@ public function setTransactionId($transaction_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeTransferRule.php b/src/Model/EnvelopeTransferRule.php index 9d593ea7..9fab19eb 100644 --- a/src/Model/EnvelopeTransferRule.php +++ b/src/Model/EnvelopeTransferRule.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeTransferRule Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeTransferRule implements ArrayAccess +class EnvelopeTransferRule implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeTransferRule'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class EnvelopeTransferRule implements ArrayAccess 'to_user' => '\DocuSign\eSign\Model\UserInformation' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'carbon_copy_original_owner' => null, + 'enabled' => null, + 'envelope_transfer_rule_id' => null, + 'event_type' => null, + 'from_group' => null, + 'from_user' => null, + 'modified_date' => null, + 'modified_user' => null, + 'to_folder' => null, + 'to_user' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'to_user' => 'toUser' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'to_user' => 'setToUser' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'to_user' => 'getToUser' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets carbon_copy_original_owner + * * @return string */ public function getCarbonCopyOriginalOwner() @@ -201,7 +270,9 @@ public function getCarbonCopyOriginalOwner() /** * Sets carbon_copy_original_owner + * * @param string $carbon_copy_original_owner + * * @return $this */ public function setCarbonCopyOriginalOwner($carbon_copy_original_owner) @@ -213,6 +284,7 @@ public function setCarbonCopyOriginalOwner($carbon_copy_original_owner) /** * Gets enabled + * * @return string */ public function getEnabled() @@ -222,7 +294,9 @@ public function getEnabled() /** * Sets enabled + * * @param string $enabled + * * @return $this */ public function setEnabled($enabled) @@ -234,6 +308,7 @@ public function setEnabled($enabled) /** * Gets envelope_transfer_rule_id + * * @return string */ public function getEnvelopeTransferRuleId() @@ -243,7 +318,9 @@ public function getEnvelopeTransferRuleId() /** * Sets envelope_transfer_rule_id + * * @param string $envelope_transfer_rule_id + * * @return $this */ public function setEnvelopeTransferRuleId($envelope_transfer_rule_id) @@ -255,6 +332,7 @@ public function setEnvelopeTransferRuleId($envelope_transfer_rule_id) /** * Gets event_type + * * @return string */ public function getEventType() @@ -264,7 +342,9 @@ public function getEventType() /** * Sets event_type + * * @param string $event_type + * * @return $this */ public function setEventType($event_type) @@ -276,6 +356,7 @@ public function setEventType($event_type) /** * Gets from_group + * * @return \DocuSign\eSign\Model\Group */ public function getFromGroup() @@ -285,7 +366,9 @@ public function getFromGroup() /** * Sets from_group - * @param \DocuSign\eSign\Model\Group $from_group + * + * @param \DocuSign\eSign\Model\Group $from_group from_group + * * @return $this */ public function setFromGroup($from_group) @@ -297,6 +380,7 @@ public function setFromGroup($from_group) /** * Gets from_user + * * @return \DocuSign\eSign\Model\UserInformation */ public function getFromUser() @@ -306,7 +390,9 @@ public function getFromUser() /** * Sets from_user - * @param \DocuSign\eSign\Model\UserInformation $from_user + * + * @param \DocuSign\eSign\Model\UserInformation $from_user from_user + * * @return $this */ public function setFromUser($from_user) @@ -318,6 +404,7 @@ public function setFromUser($from_user) /** * Gets modified_date + * * @return string */ public function getModifiedDate() @@ -327,7 +414,9 @@ public function getModifiedDate() /** * Sets modified_date + * * @param string $modified_date + * * @return $this */ public function setModifiedDate($modified_date) @@ -339,6 +428,7 @@ public function setModifiedDate($modified_date) /** * Gets modified_user + * * @return \DocuSign\eSign\Model\UserInformation */ public function getModifiedUser() @@ -348,7 +438,9 @@ public function getModifiedUser() /** * Sets modified_user - * @param \DocuSign\eSign\Model\UserInformation $modified_user + * + * @param \DocuSign\eSign\Model\UserInformation $modified_user modified_user + * * @return $this */ public function setModifiedUser($modified_user) @@ -360,6 +452,7 @@ public function setModifiedUser($modified_user) /** * Gets to_folder + * * @return \DocuSign\eSign\Model\Folder */ public function getToFolder() @@ -369,7 +462,9 @@ public function getToFolder() /** * Sets to_folder - * @param \DocuSign\eSign\Model\Folder $to_folder + * + * @param \DocuSign\eSign\Model\Folder $to_folder to_folder + * * @return $this */ public function setToFolder($to_folder) @@ -381,6 +476,7 @@ public function setToFolder($to_folder) /** * Gets to_user + * * @return \DocuSign\eSign\Model\UserInformation */ public function getToUser() @@ -390,7 +486,9 @@ public function getToUser() /** * Sets to_user - * @param \DocuSign\eSign\Model\UserInformation $to_user + * + * @param \DocuSign\eSign\Model\UserInformation $to_user to_user + * * @return $this */ public function setToUser($to_user) @@ -401,7 +499,9 @@ public function setToUser($to_user) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeTransferRuleInformation.php b/src/Model/EnvelopeTransferRuleInformation.php index 050d515b..8dae751c 100644 --- a/src/Model/EnvelopeTransferRuleInformation.php +++ b/src/Model/EnvelopeTransferRuleInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeTransferRuleInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeTransferRuleInformation implements ArrayAccess +class EnvelopeTransferRuleInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeTransferRuleInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class EnvelopeTransferRuleInformation implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'envelope_transfer_rules' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets envelope_transfer_rules + * * @return \DocuSign\eSign\Model\EnvelopeTransferRule[] */ public function getEnvelopeTransferRules() @@ -207,7 +276,9 @@ public function getEnvelopeTransferRules() /** * Sets envelope_transfer_rules + * * @param \DocuSign\eSign\Model\EnvelopeTransferRule[] $envelope_transfer_rules + * * @return $this */ public function setEnvelopeTransferRules($envelope_transfer_rules) @@ -219,6 +290,7 @@ public function setEnvelopeTransferRules($envelope_transfer_rules) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -228,7 +300,9 @@ public function getNextUri() /** * 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) @@ -240,6 +314,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeTransferRuleRequest.php b/src/Model/EnvelopeTransferRuleRequest.php index ff2ff761..5497f310 100644 --- a/src/Model/EnvelopeTransferRuleRequest.php +++ b/src/Model/EnvelopeTransferRuleRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeTransferRuleRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeTransferRuleRequest implements ArrayAccess +class EnvelopeTransferRuleRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeTransferRuleRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class EnvelopeTransferRuleRequest implements ArrayAccess 'to_user' => '\DocuSign\eSign\Model\UserInformation' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'carbon_copy_original_owner' => null, + 'enabled' => null, + 'envelope_transfer_rule_id' => null, + 'event_type' => null, + 'from_groups' => null, + 'from_users' => null, + 'modified_date' => null, + 'modified_user' => null, + 'to_folder' => null, + 'to_user' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'to_user' => 'toUser' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'to_user' => 'setToUser' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'to_user' => 'getToUser' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets carbon_copy_original_owner + * * @return string */ public function getCarbonCopyOriginalOwner() @@ -201,7 +270,9 @@ public function getCarbonCopyOriginalOwner() /** * Sets carbon_copy_original_owner + * * @param string $carbon_copy_original_owner + * * @return $this */ public function setCarbonCopyOriginalOwner($carbon_copy_original_owner) @@ -213,6 +284,7 @@ public function setCarbonCopyOriginalOwner($carbon_copy_original_owner) /** * Gets enabled + * * @return string */ public function getEnabled() @@ -222,7 +294,9 @@ public function getEnabled() /** * Sets enabled + * * @param string $enabled + * * @return $this */ public function setEnabled($enabled) @@ -234,6 +308,7 @@ public function setEnabled($enabled) /** * Gets envelope_transfer_rule_id + * * @return string */ public function getEnvelopeTransferRuleId() @@ -243,7 +318,9 @@ public function getEnvelopeTransferRuleId() /** * Sets envelope_transfer_rule_id + * * @param string $envelope_transfer_rule_id + * * @return $this */ public function setEnvelopeTransferRuleId($envelope_transfer_rule_id) @@ -255,6 +332,7 @@ public function setEnvelopeTransferRuleId($envelope_transfer_rule_id) /** * Gets event_type + * * @return string */ public function getEventType() @@ -264,7 +342,9 @@ public function getEventType() /** * Sets event_type + * * @param string $event_type + * * @return $this */ public function setEventType($event_type) @@ -276,6 +356,7 @@ public function setEventType($event_type) /** * Gets from_groups + * * @return \DocuSign\eSign\Model\Group[] */ public function getFromGroups() @@ -285,7 +366,9 @@ public function getFromGroups() /** * Sets from_groups + * * @param \DocuSign\eSign\Model\Group[] $from_groups + * * @return $this */ public function setFromGroups($from_groups) @@ -297,6 +380,7 @@ public function setFromGroups($from_groups) /** * Gets from_users + * * @return \DocuSign\eSign\Model\UserInformation[] */ public function getFromUsers() @@ -306,7 +390,9 @@ public function getFromUsers() /** * Sets from_users + * * @param \DocuSign\eSign\Model\UserInformation[] $from_users + * * @return $this */ public function setFromUsers($from_users) @@ -318,6 +404,7 @@ public function setFromUsers($from_users) /** * Gets modified_date + * * @return string */ public function getModifiedDate() @@ -327,7 +414,9 @@ public function getModifiedDate() /** * Sets modified_date + * * @param string $modified_date + * * @return $this */ public function setModifiedDate($modified_date) @@ -339,6 +428,7 @@ public function setModifiedDate($modified_date) /** * Gets modified_user + * * @return \DocuSign\eSign\Model\UserInformation */ public function getModifiedUser() @@ -348,7 +438,9 @@ public function getModifiedUser() /** * Sets modified_user - * @param \DocuSign\eSign\Model\UserInformation $modified_user + * + * @param \DocuSign\eSign\Model\UserInformation $modified_user modified_user + * * @return $this */ public function setModifiedUser($modified_user) @@ -360,6 +452,7 @@ public function setModifiedUser($modified_user) /** * Gets to_folder + * * @return \DocuSign\eSign\Model\Folder */ public function getToFolder() @@ -369,7 +462,9 @@ public function getToFolder() /** * Sets to_folder - * @param \DocuSign\eSign\Model\Folder $to_folder + * + * @param \DocuSign\eSign\Model\Folder $to_folder to_folder + * * @return $this */ public function setToFolder($to_folder) @@ -381,6 +476,7 @@ public function setToFolder($to_folder) /** * Gets to_user + * * @return \DocuSign\eSign\Model\UserInformation */ public function getToUser() @@ -390,7 +486,9 @@ public function getToUser() /** * Sets to_user - * @param \DocuSign\eSign\Model\UserInformation $to_user + * + * @param \DocuSign\eSign\Model\UserInformation $to_user to_user + * * @return $this */ public function setToUser($to_user) @@ -401,7 +499,9 @@ public function setToUser($to_user) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeUpdateSummary.php b/src/Model/EnvelopeUpdateSummary.php index 9edbfa71..ede4ef34 100644 --- a/src/Model/EnvelopeUpdateSummary.php +++ b/src/Model/EnvelopeUpdateSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeUpdateSummary Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeUpdateSummary implements ArrayAccess +class EnvelopeUpdateSummary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeUpdateSummary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,47 @@ class EnvelopeUpdateSummary implements ArrayAccess 'text_custom_field_update_results' => '\DocuSign\eSign\Model\TextCustomField[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_envelope_status' => null, + 'envelope_id' => null, + 'error_details' => null, + 'list_custom_field_update_results' => null, + 'lock_information' => null, + 'purge_state' => null, + 'recipient_update_results' => null, + 'tab_update_results' => null, + 'text_custom_field_update_results' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -86,9 +123,9 @@ public static function swaggerTypes() 'text_custom_field_update_results' => 'textCustomFieldUpdateResults' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -103,9 +140,9 @@ public static function swaggerTypes() 'text_custom_field_update_results' => 'setTextCustomFieldUpdateResults' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -120,34 +157,63 @@ public static function swaggerTypes() 'text_custom_field_update_results' => 'getTextCustomFieldUpdateResults' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -163,30 +229,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_envelope_status + * * @return \DocuSign\eSign\Model\BulkEnvelopeStatus */ public function getBulkEnvelopeStatus() @@ -196,7 +264,9 @@ public function getBulkEnvelopeStatus() /** * Sets bulk_envelope_status - * @param \DocuSign\eSign\Model\BulkEnvelopeStatus $bulk_envelope_status + * + * @param \DocuSign\eSign\Model\BulkEnvelopeStatus $bulk_envelope_status bulk_envelope_status + * * @return $this */ public function setBulkEnvelopeStatus($bulk_envelope_status) @@ -208,6 +278,7 @@ public function setBulkEnvelopeStatus($bulk_envelope_status) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -217,7 +288,9 @@ public function getEnvelopeId() /** * 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) @@ -229,6 +302,7 @@ public function setEnvelopeId($envelope_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -238,7 +312,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -250,6 +326,7 @@ public function setErrorDetails($error_details) /** * Gets list_custom_field_update_results + * * @return \DocuSign\eSign\Model\ListCustomField[] */ public function getListCustomFieldUpdateResults() @@ -259,7 +336,9 @@ public function getListCustomFieldUpdateResults() /** * Sets list_custom_field_update_results + * * @param \DocuSign\eSign\Model\ListCustomField[] $list_custom_field_update_results + * * @return $this */ public function setListCustomFieldUpdateResults($list_custom_field_update_results) @@ -271,6 +350,7 @@ public function setListCustomFieldUpdateResults($list_custom_field_update_result /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -280,7 +360,9 @@ public function getLockInformation() /** * Sets lock_information - * @param \DocuSign\eSign\Model\LockInformation $lock_information + * + * @param \DocuSign\eSign\Model\LockInformation $lock_information lock_information + * * @return $this */ public function setLockInformation($lock_information) @@ -292,6 +374,7 @@ public function setLockInformation($lock_information) /** * Gets purge_state + * * @return string */ public function getPurgeState() @@ -301,7 +384,9 @@ public function getPurgeState() /** * Sets purge_state + * * @param string $purge_state + * * @return $this */ public function setPurgeState($purge_state) @@ -313,6 +398,7 @@ public function setPurgeState($purge_state) /** * Gets recipient_update_results + * * @return \DocuSign\eSign\Model\RecipientUpdateResponse[] */ public function getRecipientUpdateResults() @@ -322,7 +408,9 @@ public function getRecipientUpdateResults() /** * Sets recipient_update_results + * * @param \DocuSign\eSign\Model\RecipientUpdateResponse[] $recipient_update_results + * * @return $this */ public function setRecipientUpdateResults($recipient_update_results) @@ -334,6 +422,7 @@ public function setRecipientUpdateResults($recipient_update_results) /** * Gets tab_update_results + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabUpdateResults() @@ -343,7 +432,9 @@ public function getTabUpdateResults() /** * Sets tab_update_results - * @param \DocuSign\eSign\Model\Tabs $tab_update_results + * + * @param \DocuSign\eSign\Model\Tabs $tab_update_results tab_update_results + * * @return $this */ public function setTabUpdateResults($tab_update_results) @@ -355,6 +446,7 @@ public function setTabUpdateResults($tab_update_results) /** * Gets text_custom_field_update_results + * * @return \DocuSign\eSign\Model\TextCustomField[] */ public function getTextCustomFieldUpdateResults() @@ -364,7 +456,9 @@ public function getTextCustomFieldUpdateResults() /** * Sets text_custom_field_update_results + * * @param \DocuSign\eSign\Model\TextCustomField[] $text_custom_field_update_results + * * @return $this */ public function setTextCustomFieldUpdateResults($text_custom_field_update_results) @@ -375,7 +469,9 @@ public function setTextCustomFieldUpdateResults($text_custom_field_update_result } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -385,7 +481,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -395,8 +493,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -410,7 +510,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -420,16 +522,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopesInformation.php b/src/Model/EnvelopesInformation.php index 77ffa97c..27bc42b6 100644 --- a/src/Model/EnvelopesInformation.php +++ b/src/Model/EnvelopesInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopesInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopesInformation implements ArrayAccess +class EnvelopesInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopesInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -67,13 +70,49 @@ class EnvelopesInformation implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'continuation_token' => null, + 'end_position' => null, + 'envelopes' => null, + 'envelope_transaction_statuses' => null, + 'folders' => null, + 'last_queried_date_time' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -90,9 +129,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -109,9 +148,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -128,34 +167,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -173,30 +241,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets continuation_token + * * @return string */ public function getContinuationToken() @@ -206,7 +276,9 @@ public function getContinuationToken() /** * Sets continuation_token + * * @param string $continuation_token + * * @return $this */ public function setContinuationToken($continuation_token) @@ -218,6 +290,7 @@ public function setContinuationToken($continuation_token) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -227,7 +300,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -239,6 +314,7 @@ public function setEndPosition($end_position) /** * Gets envelopes + * * @return \DocuSign\eSign\Model\Envelope[] */ public function getEnvelopes() @@ -248,7 +324,9 @@ public function getEnvelopes() /** * Sets envelopes + * * @param \DocuSign\eSign\Model\Envelope[] $envelopes + * * @return $this */ public function setEnvelopes($envelopes) @@ -260,6 +338,7 @@ public function setEnvelopes($envelopes) /** * Gets envelope_transaction_statuses + * * @return \DocuSign\eSign\Model\EnvelopeTransactionStatus[] */ public function getEnvelopeTransactionStatuses() @@ -269,7 +348,9 @@ public function getEnvelopeTransactionStatuses() /** * Sets envelope_transaction_statuses + * * @param \DocuSign\eSign\Model\EnvelopeTransactionStatus[] $envelope_transaction_statuses + * * @return $this */ public function setEnvelopeTransactionStatuses($envelope_transaction_statuses) @@ -281,6 +362,7 @@ public function setEnvelopeTransactionStatuses($envelope_transaction_statuses) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -290,7 +372,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders + * * @return $this */ public function setFolders($folders) @@ -302,6 +386,7 @@ public function setFolders($folders) /** * Gets last_queried_date_time + * * @return string */ public function getLastQueriedDateTime() @@ -311,7 +396,9 @@ public function getLastQueriedDateTime() /** * Sets last_queried_date_time + * * @param string $last_queried_date_time + * * @return $this */ public function setLastQueriedDateTime($last_queried_date_time) @@ -323,6 +410,7 @@ public function setLastQueriedDateTime($last_queried_date_time) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -332,7 +420,9 @@ public function getNextUri() /** * 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) @@ -344,6 +434,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -353,7 +444,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -365,6 +458,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -374,7 +468,9 @@ public function getResultSetSize() /** * 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) @@ -386,6 +482,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -395,7 +492,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -407,6 +506,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -416,7 +516,9 @@ public function getTotalSetSize() /** * 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) @@ -427,7 +529,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -437,7 +541,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -447,8 +553,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -462,7 +570,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -472,16 +582,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ErrorDetails.php b/src/Model/ErrorDetails.php index 565db063..c4d0a80a 100644 --- a/src/Model/ErrorDetails.php +++ b/src/Model/ErrorDetails.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ErrorDetails Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ErrorDetails implements ArrayAccess +class ErrorDetails implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'errorDetails'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,40 @@ class ErrorDetails implements ArrayAccess 'message' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_code' => null, + 'message' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -73,9 +103,9 @@ public static function swaggerTypes() 'message' => 'message' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -83,9 +113,9 @@ public static function swaggerTypes() 'message' => 'setMessage' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -93,34 +123,63 @@ public static function swaggerTypes() 'message' => 'getMessage' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -129,30 +188,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_code + * * @return string */ public function getErrorCode() @@ -162,7 +223,9 @@ public function getErrorCode() /** * Sets error_code + * * @param string $error_code An error code associated with the error. + * * @return $this */ public function setErrorCode($error_code) @@ -174,6 +237,7 @@ public function setErrorCode($error_code) /** * Gets message + * * @return string */ public function getMessage() @@ -183,7 +247,9 @@ public function getMessage() /** * Sets message + * * @param string $message A short error message. + * * @return $this */ public function setMessage($message) @@ -194,7 +260,9 @@ public function setMessage($message) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -204,7 +272,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -214,8 +284,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -229,7 +301,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -239,16 +313,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EventNotification.php b/src/Model/EventNotification.php index 37c5bab6..c345c921 100644 --- a/src/Model/EventNotification.php +++ b/src/Model/EventNotification.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EventNotification Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EventNotification implements ArrayAccess +class EventNotification implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'eventNotification'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -74,13 +77,55 @@ class EventNotification implements ArrayAccess 'use_soap_interface' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_events' => null, + 'event_data' => null, + 'include_certificate_of_completion' => null, + 'include_certificate_with_soap' => null, + 'include_document_fields' => null, + 'include_documents' => null, + 'include_envelope_void_reason' => null, + 'include_hmac' => null, + 'include_sender_account_as_custom_field' => null, + 'include_time_zone' => null, + 'logging_enabled' => null, + 'recipient_events' => null, + 'require_acknowledgment' => null, + 'sign_message_with_x509_cert' => null, + 'soap_name_space' => null, + 'url' => null, + 'use_soap_interface' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -103,9 +148,9 @@ public static function swaggerTypes() 'use_soap_interface' => 'useSoapInterface' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -128,9 +173,9 @@ public static function swaggerTypes() 'use_soap_interface' => 'setUseSoapInterface' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -153,34 +198,63 @@ public static function swaggerTypes() 'use_soap_interface' => 'getUseSoapInterface' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -204,30 +278,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_events + * * @return \DocuSign\eSign\Model\EnvelopeEvent[] */ public function getEnvelopeEvents() @@ -237,7 +313,9 @@ public function getEnvelopeEvents() /** * Sets envelope_events + * * @param \DocuSign\eSign\Model\EnvelopeEvent[] $envelope_events A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. + * * @return $this */ public function setEnvelopeEvents($envelope_events) @@ -249,6 +327,7 @@ public function setEnvelopeEvents($envelope_events) /** * Gets event_data + * * @return \DocuSign\eSign\Model\ConnectEventData */ public function getEventData() @@ -258,7 +337,9 @@ public function getEventData() /** * Sets event_data - * @param \DocuSign\eSign\Model\ConnectEventData $event_data + * + * @param \DocuSign\eSign\Model\ConnectEventData $event_data event_data + * * @return $this */ public function setEventData($event_data) @@ -270,6 +351,7 @@ public function setEventData($event_data) /** * Gets include_certificate_of_completion + * * @return string */ public function getIncludeCertificateOfCompletion() @@ -279,7 +361,9 @@ public function getIncludeCertificateOfCompletion() /** * Sets include_certificate_of_completion + * * @param string $include_certificate_of_completion When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. + * * @return $this */ public function setIncludeCertificateOfCompletion($include_certificate_of_completion) @@ -291,6 +375,7 @@ public function setIncludeCertificateOfCompletion($include_certificate_of_comple /** * Gets include_certificate_with_soap + * * @return string */ public function getIncludeCertificateWithSoap() @@ -300,7 +385,9 @@ public function getIncludeCertificateWithSoap() /** * Sets include_certificate_with_soap + * * @param string $include_certificate_with_soap When set to **true**, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken. + * * @return $this */ public function setIncludeCertificateWithSoap($include_certificate_with_soap) @@ -312,6 +399,7 @@ public function setIncludeCertificateWithSoap($include_certificate_with_soap) /** * Gets include_document_fields + * * @return string */ public function getIncludeDocumentFields() @@ -321,7 +409,9 @@ public function getIncludeDocumentFields() /** * Sets include_document_fields + * * @param string $include_document_fields When set to **true**, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API. + * * @return $this */ public function setIncludeDocumentFields($include_document_fields) @@ -333,6 +423,7 @@ public function setIncludeDocumentFields($include_document_fields) /** * Gets include_documents + * * @return string */ public function getIncludeDocuments() @@ -342,7 +433,9 @@ public function getIncludeDocuments() /** * Sets include_documents + * * @param string $include_documents When set to **true**, the PDF documents are included in the message along with the updated XML. + * * @return $this */ public function setIncludeDocuments($include_documents) @@ -354,6 +447,7 @@ public function setIncludeDocuments($include_documents) /** * Gets include_envelope_void_reason + * * @return string */ public function getIncludeEnvelopeVoidReason() @@ -363,7 +457,9 @@ public function getIncludeEnvelopeVoidReason() /** * Sets include_envelope_void_reason + * * @param string $include_envelope_void_reason When set to **true**, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. + * * @return $this */ public function setIncludeEnvelopeVoidReason($include_envelope_void_reason) @@ -375,6 +471,7 @@ public function setIncludeEnvelopeVoidReason($include_envelope_void_reason) /** * Gets include_hmac + * * @return string */ public function getIncludeHmac() @@ -384,7 +481,9 @@ public function getIncludeHmac() /** * Sets include_hmac + * * @param string $include_hmac + * * @return $this */ public function setIncludeHmac($include_hmac) @@ -396,6 +495,7 @@ public function setIncludeHmac($include_hmac) /** * Gets include_sender_account_as_custom_field + * * @return string */ public function getIncludeSenderAccountAsCustomField() @@ -405,7 +505,9 @@ public function getIncludeSenderAccountAsCustomField() /** * Sets include_sender_account_as_custom_field + * * @param string $include_sender_account_as_custom_field When set to **true**, the sender account ID is included as a envelope custom field in the data. + * * @return $this */ public function setIncludeSenderAccountAsCustomField($include_sender_account_as_custom_field) @@ -417,6 +519,7 @@ public function setIncludeSenderAccountAsCustomField($include_sender_account_as_ /** * Gets include_time_zone + * * @return string */ public function getIncludeTimeZone() @@ -426,7 +529,9 @@ public function getIncludeTimeZone() /** * Sets include_time_zone + * * @param string $include_time_zone When set to **true**, the envelope time zone information is included in the message. + * * @return $this */ public function setIncludeTimeZone($include_time_zone) @@ -438,6 +543,7 @@ public function setIncludeTimeZone($include_time_zone) /** * Gets logging_enabled + * * @return string */ public function getLoggingEnabled() @@ -447,7 +553,9 @@ public function getLoggingEnabled() /** * Sets logging_enabled + * * @param string $logging_enabled When set to **true**, logging is turned on for envelope events on the Web Console Connect page. + * * @return $this */ public function setLoggingEnabled($logging_enabled) @@ -459,6 +567,7 @@ public function setLoggingEnabled($logging_enabled) /** * Gets recipient_events + * * @return \DocuSign\eSign\Model\RecipientEvent[] */ public function getRecipientEvents() @@ -468,7 +577,9 @@ public function getRecipientEvents() /** * Sets recipient_events + * * @param \DocuSign\eSign\Model\RecipientEvent[] $recipient_events A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. + * * @return $this */ public function setRecipientEvents($recipient_events) @@ -480,6 +591,7 @@ public function setRecipientEvents($recipient_events) /** * Gets require_acknowledgment + * * @return string */ public function getRequireAcknowledgment() @@ -489,7 +601,9 @@ public function getRequireAcknowledgment() /** * Sets require_acknowledgment + * * @param string $require_acknowledgment When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. + * * @return $this */ public function setRequireAcknowledgment($require_acknowledgment) @@ -501,6 +615,7 @@ public function setRequireAcknowledgment($require_acknowledgment) /** * Gets sign_message_with_x509_cert + * * @return string */ public function getSignMessageWithX509Cert() @@ -510,7 +625,9 @@ public function getSignMessageWithX509Cert() /** * Sets sign_message_with_x509_cert + * * @param string $sign_message_with_x509_cert When set to **true**, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. + * * @return $this */ public function setSignMessageWithX509Cert($sign_message_with_x509_cert) @@ -522,6 +639,7 @@ public function setSignMessageWithX509Cert($sign_message_with_x509_cert) /** * Gets soap_name_space + * * @return string */ public function getSoapNameSpace() @@ -531,7 +649,9 @@ public function getSoapNameSpace() /** * Sets soap_name_space + * * @param string $soap_name_space This lists the namespace in the SOAP listener provided. + * * @return $this */ public function setSoapNameSpace($soap_name_space) @@ -543,6 +663,7 @@ public function setSoapNameSpace($soap_name_space) /** * Gets url + * * @return string */ public function getUrl() @@ -552,7 +673,9 @@ public function getUrl() /** * Sets url + * * @param string $url Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless `useSoapInterface` property is set to **true**. + * * @return $this */ public function setUrl($url) @@ -564,6 +687,7 @@ public function setUrl($url) /** * Gets use_soap_interface + * * @return string */ public function getUseSoapInterface() @@ -573,7 +697,9 @@ public function getUseSoapInterface() /** * Sets use_soap_interface + * * @param string $use_soap_interface When set to **true**, this tells the Connect service that the user's endpoint has implemented a SOAP interface. + * * @return $this */ public function setUseSoapInterface($use_soap_interface) @@ -584,7 +710,9 @@ public function setUseSoapInterface($use_soap_interface) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -594,7 +722,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -604,8 +734,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -619,7 +751,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -629,16 +763,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EventResult.php b/src/Model/EventResult.php index e172fe8a..d43c02bb 100644 --- a/src/Model/EventResult.php +++ b/src/Model/EventResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EventResult Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EventResult implements ArrayAccess +class EventResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'eventResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class EventResult implements ArrayAccess 'vendor_failure_status_code' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'event_timestamp' => null, + 'failure_description' => null, + 'status' => null, + 'vendor_failure_status_code' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'vendor_failure_status_code' => 'vendorFailureStatusCode' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'vendor_failure_status_code' => 'setVendorFailureStatusCode' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'vendor_failure_status_code' => 'getVendorFailureStatusCode' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets event_timestamp + * * @return string */ public function getEventTimestamp() @@ -171,7 +234,9 @@ public function getEventTimestamp() /** * Sets event_timestamp + * * @param string $event_timestamp + * * @return $this */ public function setEventTimestamp($event_timestamp) @@ -183,6 +248,7 @@ public function setEventTimestamp($event_timestamp) /** * Gets failure_description + * * @return string */ public function getFailureDescription() @@ -192,7 +258,9 @@ public function getFailureDescription() /** * Sets failure_description + * * @param string $failure_description + * * @return $this */ public function setFailureDescription($failure_description) @@ -204,6 +272,7 @@ public function setFailureDescription($failure_description) /** * Gets status + * * @return string */ public function getStatus() @@ -213,7 +282,9 @@ public function getStatus() /** * 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) @@ -225,6 +296,7 @@ public function setStatus($status) /** * Gets vendor_failure_status_code + * * @return string */ public function getVendorFailureStatusCode() @@ -234,7 +306,9 @@ public function getVendorFailureStatusCode() /** * Sets vendor_failure_status_code + * * @param string $vendor_failure_status_code + * * @return $this */ public function setVendorFailureStatusCode($vendor_failure_status_code) @@ -245,7 +319,9 @@ public function setVendorFailureStatusCode($vendor_failure_status_code) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Expirations.php b/src/Model/Expirations.php index dfb69ced..644652cc 100644 --- a/src/Model/Expirations.php +++ b/src/Model/Expirations.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Expirations Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Expirations implements ArrayAccess +class Expirations implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'expirations'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class Expirations implements ArrayAccess 'expire_warn' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'expire_after' => null, + 'expire_enabled' => null, + 'expire_warn' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'expire_warn' => 'expireWarn' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'expire_warn' => 'setExpireWarn' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'expire_warn' => 'getExpireWarn' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets expire_after + * * @return string */ public function getExpireAfter() @@ -167,7 +229,9 @@ public function getExpireAfter() /** * Sets expire_after + * * @param string $expire_after An integer that sets the number of days the envelope is active. + * * @return $this */ public function setExpireAfter($expire_after) @@ -179,6 +243,7 @@ public function setExpireAfter($expire_after) /** * Gets expire_enabled + * * @return string */ public function getExpireEnabled() @@ -188,7 +253,9 @@ public function getExpireEnabled() /** * Sets expire_enabled + * * @param string $expire_enabled When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. + * * @return $this */ public function setExpireEnabled($expire_enabled) @@ -200,6 +267,7 @@ public function setExpireEnabled($expire_enabled) /** * Gets expire_warn + * * @return string */ public function getExpireWarn() @@ -209,7 +277,9 @@ public function getExpireWarn() /** * Sets expire_warn + * * @param string $expire_warn An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent. + * * @return $this */ public function setExpireWarn($expire_warn) @@ -220,7 +290,9 @@ public function setExpireWarn($expire_warn) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ExternalDocServiceErrorDetails.php b/src/Model/ExternalDocServiceErrorDetails.php index ffa6f6a0..99211259 100644 --- a/src/Model/ExternalDocServiceErrorDetails.php +++ b/src/Model/ExternalDocServiceErrorDetails.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ExternalDocServiceErrorDetails Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ExternalDocServiceErrorDetails implements ArrayAccess +class ExternalDocServiceErrorDetails implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'externalDocServiceErrorDetails'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class ExternalDocServiceErrorDetails implements ArrayAccess 'message' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'authentication_url' => null, + 'error_code' => null, + 'message' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'message' => 'message' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'message' => 'setMessage' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'message' => 'getMessage' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets authentication_url + * * @return string */ public function getAuthenticationUrl() @@ -166,7 +228,9 @@ public function getAuthenticationUrl() /** * Sets authentication_url + * * @param string $authentication_url Reserved: TBD + * * @return $this */ public function setAuthenticationUrl($authentication_url) @@ -178,6 +242,7 @@ public function setAuthenticationUrl($authentication_url) /** * Gets error_code + * * @return string */ public function getErrorCode() @@ -187,7 +252,9 @@ public function getErrorCode() /** * Sets error_code + * * @param string $error_code + * * @return $this */ public function setErrorCode($error_code) @@ -199,6 +266,7 @@ public function setErrorCode($error_code) /** * Gets message + * * @return string */ public function getMessage() @@ -208,7 +276,9 @@ public function getMessage() /** * Sets message + * * @param string $message + * * @return $this */ public function setMessage($message) @@ -219,7 +289,9 @@ public function setMessage($message) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ExternalDocumentSources.php b/src/Model/ExternalDocumentSources.php index a9c3a514..c283f0f6 100644 --- a/src/Model/ExternalDocumentSources.php +++ b/src/Model/ExternalDocumentSources.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ExternalDocumentSources Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ExternalDocumentSources implements ArrayAccess +class ExternalDocumentSources implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'externalDocumentSources'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class ExternalDocumentSources implements ArrayAccess 'salesforce_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'boxnet_enabled' => null, + 'boxnet_metadata' => null, + 'dropbox_enabled' => null, + 'dropbox_metadata' => null, + 'google_drive_enabled' => null, + 'google_drive_metadata' => null, + 'one_drive_enabled' => null, + 'one_drive_metadata' => null, + 'salesforce_enabled' => null, + 'salesforce_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'salesforce_metadata' => 'salesforceMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'salesforce_metadata' => 'setSalesforceMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'salesforce_metadata' => 'getSalesforceMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets boxnet_enabled + * * @return string */ public function getBoxnetEnabled() @@ -201,7 +270,9 @@ public function getBoxnetEnabled() /** * Sets boxnet_enabled + * * @param string $boxnet_enabled + * * @return $this */ public function setBoxnetEnabled($boxnet_enabled) @@ -213,6 +284,7 @@ public function setBoxnetEnabled($boxnet_enabled) /** * Gets boxnet_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getBoxnetMetadata() @@ -222,7 +294,9 @@ public function getBoxnetMetadata() /** * Sets boxnet_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $boxnet_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $boxnet_metadata boxnet_metadata + * * @return $this */ public function setBoxnetMetadata($boxnet_metadata) @@ -234,6 +308,7 @@ public function setBoxnetMetadata($boxnet_metadata) /** * Gets dropbox_enabled + * * @return string */ public function getDropboxEnabled() @@ -243,7 +318,9 @@ public function getDropboxEnabled() /** * Sets dropbox_enabled + * * @param string $dropbox_enabled + * * @return $this */ public function setDropboxEnabled($dropbox_enabled) @@ -255,6 +332,7 @@ public function setDropboxEnabled($dropbox_enabled) /** * Gets dropbox_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDropboxMetadata() @@ -264,7 +342,9 @@ public function getDropboxMetadata() /** * Sets dropbox_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $dropbox_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $dropbox_metadata dropbox_metadata + * * @return $this */ public function setDropboxMetadata($dropbox_metadata) @@ -276,6 +356,7 @@ public function setDropboxMetadata($dropbox_metadata) /** * Gets google_drive_enabled + * * @return string */ public function getGoogleDriveEnabled() @@ -285,7 +366,9 @@ public function getGoogleDriveEnabled() /** * Sets google_drive_enabled + * * @param string $google_drive_enabled + * * @return $this */ public function setGoogleDriveEnabled($google_drive_enabled) @@ -297,6 +380,7 @@ public function setGoogleDriveEnabled($google_drive_enabled) /** * Gets google_drive_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getGoogleDriveMetadata() @@ -306,7 +390,9 @@ public function getGoogleDriveMetadata() /** * Sets google_drive_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $google_drive_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $google_drive_metadata google_drive_metadata + * * @return $this */ public function setGoogleDriveMetadata($google_drive_metadata) @@ -318,6 +404,7 @@ public function setGoogleDriveMetadata($google_drive_metadata) /** * Gets one_drive_enabled + * * @return string */ public function getOneDriveEnabled() @@ -327,7 +414,9 @@ public function getOneDriveEnabled() /** * Sets one_drive_enabled + * * @param string $one_drive_enabled + * * @return $this */ public function setOneDriveEnabled($one_drive_enabled) @@ -339,6 +428,7 @@ public function setOneDriveEnabled($one_drive_enabled) /** * Gets one_drive_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getOneDriveMetadata() @@ -348,7 +438,9 @@ public function getOneDriveMetadata() /** * Sets one_drive_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $one_drive_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $one_drive_metadata one_drive_metadata + * * @return $this */ public function setOneDriveMetadata($one_drive_metadata) @@ -360,6 +452,7 @@ public function setOneDriveMetadata($one_drive_metadata) /** * Gets salesforce_enabled + * * @return string */ public function getSalesforceEnabled() @@ -369,7 +462,9 @@ public function getSalesforceEnabled() /** * Sets salesforce_enabled + * * @param string $salesforce_enabled + * * @return $this */ public function setSalesforceEnabled($salesforce_enabled) @@ -381,6 +476,7 @@ public function setSalesforceEnabled($salesforce_enabled) /** * Gets salesforce_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSalesforceMetadata() @@ -390,7 +486,9 @@ public function getSalesforceMetadata() /** * Sets salesforce_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $salesforce_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $salesforce_metadata salesforce_metadata + * * @return $this */ public function setSalesforceMetadata($salesforce_metadata) @@ -401,7 +499,9 @@ public function setSalesforceMetadata($salesforce_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ExternalFile.php b/src/Model/ExternalFile.php index 1d64be6a..e37fb924 100644 --- a/src/Model/ExternalFile.php +++ b/src/Model/ExternalFile.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ExternalFile Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ExternalFile implements ArrayAccess +class ExternalFile implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'externalFile'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class ExternalFile implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'date' => null, + 'id' => null, + 'img' => null, + 'name' => null, + 'size' => null, + 'supported' => null, + 'type' => null, + 'uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'uri' => 'getUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets date + * * @return string */ public function getDate() @@ -191,7 +258,9 @@ public function getDate() /** * Sets date + * * @param string $date + * * @return $this */ public function setDate($date) @@ -203,6 +272,7 @@ public function setDate($date) /** * Gets id + * * @return string */ public function getId() @@ -212,7 +282,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -224,6 +296,7 @@ public function setId($id) /** * Gets img + * * @return string */ public function getImg() @@ -233,7 +306,9 @@ public function getImg() /** * Sets img + * * @param string $img + * * @return $this */ public function setImg($img) @@ -245,6 +320,7 @@ public function setImg($img) /** * Gets name + * * @return string */ public function getName() @@ -254,7 +330,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -266,6 +344,7 @@ public function setName($name) /** * Gets size + * * @return string */ public function getSize() @@ -275,7 +354,9 @@ public function getSize() /** * Sets size + * * @param string $size Reserved: TBD + * * @return $this */ public function setSize($size) @@ -287,6 +368,7 @@ public function setSize($size) /** * Gets supported + * * @return string */ public function getSupported() @@ -296,7 +378,9 @@ public function getSupported() /** * Sets supported + * * @param string $supported + * * @return $this */ public function setSupported($supported) @@ -308,6 +392,7 @@ public function setSupported($supported) /** * Gets type + * * @return string */ public function getType() @@ -317,7 +402,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -329,6 +416,7 @@ public function setType($type) /** * Gets uri + * * @return string */ public function getUri() @@ -338,7 +426,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -349,7 +439,9 @@ public function setUri($uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ExternalFolder.php b/src/Model/ExternalFolder.php index d9834c42..d2a1d128 100644 --- a/src/Model/ExternalFolder.php +++ b/src/Model/ExternalFolder.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ExternalFolder Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ExternalFolder implements ArrayAccess +class ExternalFolder implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'externalFolder'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class ExternalFolder implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'error_details' => null, + 'id' => null, + 'items' => null, + 'name' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -201,7 +270,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -213,6 +284,7 @@ public function setEndPosition($end_position) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ExternalDocServiceErrorDetails */ public function getErrorDetails() @@ -222,7 +294,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ExternalDocServiceErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ExternalDocServiceErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -234,6 +308,7 @@ public function setErrorDetails($error_details) /** * Gets id + * * @return string */ public function getId() @@ -243,7 +318,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -255,6 +332,7 @@ public function setId($id) /** * Gets items + * * @return \DocuSign\eSign\Model\ExternalFile[] */ public function getItems() @@ -264,7 +342,9 @@ public function getItems() /** * Sets items + * * @param \DocuSign\eSign\Model\ExternalFile[] $items + * * @return $this */ public function setItems($items) @@ -276,6 +356,7 @@ public function setItems($items) /** * Gets name + * * @return string */ public function getName() @@ -285,7 +366,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -297,6 +380,7 @@ public function setName($name) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -306,7 +390,9 @@ public function getNextUri() /** * 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) @@ -318,6 +404,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -327,7 +414,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -339,6 +428,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -348,7 +438,9 @@ public function getResultSetSize() /** * 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) @@ -360,6 +452,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -369,7 +462,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -381,6 +476,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -390,7 +486,9 @@ public function getTotalSetSize() /** * 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) @@ -401,7 +499,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FavoriteTemplatesContentItem.php b/src/Model/FavoriteTemplatesContentItem.php index 0669521c..19532ce2 100644 --- a/src/Model/FavoriteTemplatesContentItem.php +++ b/src/Model/FavoriteTemplatesContentItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FavoriteTemplatesContentItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FavoriteTemplatesContentItem implements ArrayAccess +class FavoriteTemplatesContentItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'favoriteTemplatesContentItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class FavoriteTemplatesContentItem implements ArrayAccess 'template_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'favorited_date' => null, + 'template_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'template_id' => 'templateId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'template_id' => 'setTemplateId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'template_id' => 'getTemplateId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -166,7 +228,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -178,6 +242,7 @@ public function setErrorDetails($error_details) /** * Gets favorited_date + * * @return string */ public function getFavoritedDate() @@ -187,7 +252,9 @@ public function getFavoritedDate() /** * Sets favorited_date + * * @param string $favorited_date + * * @return $this */ public function setFavoritedDate($favorited_date) @@ -199,6 +266,7 @@ public function setFavoritedDate($favorited_date) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -208,7 +276,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -219,7 +289,9 @@ public function setTemplateId($template_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FavoriteTemplatesInfo.php b/src/Model/FavoriteTemplatesInfo.php index dd878a1a..9b287e6a 100644 --- a/src/Model/FavoriteTemplatesInfo.php +++ b/src/Model/FavoriteTemplatesInfo.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FavoriteTemplatesInfo Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FavoriteTemplatesInfo implements ArrayAccess +class FavoriteTemplatesInfo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'favoriteTemplatesInfo'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class FavoriteTemplatesInfo implements ArrayAccess 'templates_updated_count' => 'int' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'favorite_templates' => null, + 'templates_updated_count' => 'int32' + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'templates_updated_count' => 'templatesUpdatedCount' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'templates_updated_count' => 'setTemplatesUpdatedCount' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'templates_updated_count' => 'getTemplatesUpdatedCount' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -166,7 +228,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -178,6 +242,7 @@ public function setErrorDetails($error_details) /** * Gets favorite_templates + * * @return \DocuSign\eSign\Model\FavoriteTemplatesContentItem[] */ public function getFavoriteTemplates() @@ -187,7 +252,9 @@ public function getFavoriteTemplates() /** * Sets favorite_templates + * * @param \DocuSign\eSign\Model\FavoriteTemplatesContentItem[] $favorite_templates + * * @return $this */ public function setFavoriteTemplates($favorite_templates) @@ -199,6 +266,7 @@ public function setFavoriteTemplates($favorite_templates) /** * Gets templates_updated_count + * * @return int */ public function getTemplatesUpdatedCount() @@ -208,7 +276,9 @@ public function getTemplatesUpdatedCount() /** * Sets templates_updated_count + * * @param int $templates_updated_count + * * @return $this */ public function setTemplatesUpdatedCount($templates_updated_count) @@ -219,7 +289,9 @@ public function setTemplatesUpdatedCount($templates_updated_count) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FeatureAvailableMetadata.php b/src/Model/FeatureAvailableMetadata.php index e40001e8..7163a948 100644 --- a/src/Model/FeatureAvailableMetadata.php +++ b/src/Model/FeatureAvailableMetadata.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FeatureAvailableMetadata Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FeatureAvailableMetadata implements ArrayAccess +class FeatureAvailableMetadata implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'featureAvailableMetadata'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class FeatureAvailableMetadata implements ArrayAccess 'feature_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'availabilty' => null, + 'feature_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'feature_name' => 'featureName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'feature_name' => 'setFeatureName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'feature_name' => 'getFeatureName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets availabilty + * * @return string */ public function getAvailabilty() @@ -161,7 +222,9 @@ public function getAvailabilty() /** * Sets availabilty + * * @param string $availabilty + * * @return $this */ public function setAvailabilty($availabilty) @@ -173,6 +236,7 @@ public function setAvailabilty($availabilty) /** * Gets feature_name + * * @return string */ public function getFeatureName() @@ -182,7 +246,9 @@ public function getFeatureName() /** * Sets feature_name + * * @param string $feature_name + * * @return $this */ public function setFeatureName($feature_name) @@ -193,7 +259,9 @@ public function setFeatureName($feature_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FeatureSet.php b/src/Model/FeatureSet.php index a89ccaf0..69d4b8bc 100644 --- a/src/Model/FeatureSet.php +++ b/src/Model/FeatureSet.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FeatureSet Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FeatureSet implements ArrayAccess +class FeatureSet implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'featureSet'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,47 @@ class FeatureSet implements ArrayAccess 'seat_fee' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'currency_feature_set_prices' => null, + 'envelope_fee' => null, + 'feature_set_id' => null, + 'fixed_fee' => null, + 'is21_cfr_part11' => null, + 'is_active' => null, + 'is_enabled' => null, + 'name' => null, + 'seat_fee' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -86,9 +123,9 @@ public static function swaggerTypes() 'seat_fee' => 'seatFee' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -103,9 +140,9 @@ public static function swaggerTypes() 'seat_fee' => 'setSeatFee' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -120,34 +157,63 @@ public static function swaggerTypes() 'seat_fee' => 'getSeatFee' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -163,30 +229,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets currency_feature_set_prices + * * @return \DocuSign\eSign\Model\CurrencyFeatureSetPrice[] */ public function getCurrencyFeatureSetPrices() @@ -196,7 +264,9 @@ public function getCurrencyFeatureSetPrices() /** * Sets currency_feature_set_prices + * * @param \DocuSign\eSign\Model\CurrencyFeatureSetPrice[] $currency_feature_set_prices A complex type that contains alternate currency values that are configured for this plan feature set. + * * @return $this */ public function setCurrencyFeatureSetPrices($currency_feature_set_prices) @@ -208,6 +278,7 @@ public function setCurrencyFeatureSetPrices($currency_feature_set_prices) /** * Gets envelope_fee + * * @return string */ public function getEnvelopeFee() @@ -217,7 +288,9 @@ public function getEnvelopeFee() /** * Sets envelope_fee + * * @param string $envelope_fee + * * @return $this */ public function setEnvelopeFee($envelope_fee) @@ -229,6 +302,7 @@ public function setEnvelopeFee($envelope_fee) /** * Gets feature_set_id + * * @return string */ public function getFeatureSetId() @@ -238,7 +312,9 @@ public function getFeatureSetId() /** * Sets feature_set_id + * * @param string $feature_set_id A unique ID for the feature set. + * * @return $this */ public function setFeatureSetId($feature_set_id) @@ -250,6 +326,7 @@ public function setFeatureSetId($feature_set_id) /** * Gets fixed_fee + * * @return string */ public function getFixedFee() @@ -259,7 +336,9 @@ public function getFixedFee() /** * Sets fixed_fee + * * @param string $fixed_fee + * * @return $this */ public function setFixedFee($fixed_fee) @@ -271,6 +350,7 @@ public function setFixedFee($fixed_fee) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -280,7 +360,9 @@ public function getIs21CfrPart11() /** * Sets is21_cfr_part11 + * * @param string $is21_cfr_part11 When set to **true**, indicates that this module is enabled on the account. + * * @return $this */ public function setIs21CfrPart11($is21_cfr_part11) @@ -292,6 +374,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets is_active + * * @return string */ public function getIsActive() @@ -301,7 +384,9 @@ public function getIsActive() /** * Sets is_active + * * @param string $is_active + * * @return $this */ public function setIsActive($is_active) @@ -313,6 +398,7 @@ public function setIsActive($is_active) /** * Gets is_enabled + * * @return string */ public function getIsEnabled() @@ -322,7 +408,9 @@ public function getIsEnabled() /** * Sets is_enabled + * * @param string $is_enabled Specifies whether the feature set is actively enabled as part of the plan. + * * @return $this */ public function setIsEnabled($is_enabled) @@ -334,6 +422,7 @@ public function setIsEnabled($is_enabled) /** * Gets name + * * @return string */ public function getName() @@ -343,7 +432,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -355,6 +446,7 @@ public function setName($name) /** * Gets seat_fee + * * @return string */ public function getSeatFee() @@ -364,7 +456,9 @@ public function getSeatFee() /** * Sets seat_fee + * * @param string $seat_fee An incremental seat cost for seat-based plans. Only valid when isEnabled for the feature set is set to true. + * * @return $this */ public function setSeatFee($seat_fee) @@ -375,7 +469,9 @@ public function setSeatFee($seat_fee) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -385,7 +481,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -395,8 +493,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -410,7 +510,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -420,16 +522,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FileType.php b/src/Model/FileType.php index d2f98cdc..3edf9ccd 100644 --- a/src/Model/FileType.php +++ b/src/Model/FileType.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FileType Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FileType implements ArrayAccess +class FileType implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'fileType'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class FileType implements ArrayAccess 'mime_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'file_extension' => null, + 'mime_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'mime_type' => 'mimeType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'mime_type' => 'setMimeType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'mime_type' => 'getMimeType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets file_extension + * * @return string */ public function getFileExtension() @@ -161,7 +222,9 @@ public function getFileExtension() /** * Sets file_extension + * * @param string $file_extension + * * @return $this */ public function setFileExtension($file_extension) @@ -173,6 +236,7 @@ public function setFileExtension($file_extension) /** * Gets mime_type + * * @return string */ public function getMimeType() @@ -182,7 +246,9 @@ public function getMimeType() /** * Sets mime_type + * * @param string $mime_type The mime-type of a file type listed in a fileTypes collection. + * * @return $this */ public function setMimeType($mime_type) @@ -193,7 +259,9 @@ public function setMimeType($mime_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FileTypeList.php b/src/Model/FileTypeList.php index 5d0a0c3f..9bd9427f 100644 --- a/src/Model/FileTypeList.php +++ b/src/Model/FileTypeList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FileTypeList Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FileTypeList implements ArrayAccess +class FileTypeList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'fileTypeList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'file_types' => '\DocuSign\eSign\Model\FileType[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'file_types' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'file_types' => 'fileTypes' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'file_types' => 'setFileTypes' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'file_types' => 'getFileTypes' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets file_types + * * @return \DocuSign\eSign\Model\FileType[] */ public function getFileTypes() @@ -156,7 +216,9 @@ public function getFileTypes() /** * Sets file_types + * * @param \DocuSign\eSign\Model\FileType[] $file_types A collection of file types. + * * @return $this */ public function setFileTypes($file_types) @@ -167,7 +229,9 @@ public function setFileTypes($file_types) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Filter.php b/src/Model/Filter.php index f302d039..baf7b194 100644 --- a/src/Model/Filter.php +++ b/src/Model/Filter.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Filter Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Filter implements ArrayAccess +class Filter implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'filter'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -67,13 +70,49 @@ class Filter implements ArrayAccess 'to_date_time' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'action_required' => null, + 'expires' => null, + 'folder_ids' => null, + 'from_date_time' => null, + 'is_template' => null, + 'order' => null, + 'order_by' => null, + 'search_target' => null, + 'search_text' => null, + 'status' => null, + 'to_date_time' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -90,9 +129,9 @@ public static function swaggerTypes() 'to_date_time' => 'toDateTime' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -109,9 +148,9 @@ public static function swaggerTypes() 'to_date_time' => 'setToDateTime' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -128,34 +167,63 @@ public static function swaggerTypes() 'to_date_time' => 'getToDateTime' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -173,30 +241,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets action_required + * * @return string */ public function getActionRequired() @@ -206,7 +276,9 @@ public function getActionRequired() /** * Sets action_required + * * @param string $action_required Access token information. + * * @return $this */ public function setActionRequired($action_required) @@ -218,6 +290,7 @@ public function setActionRequired($action_required) /** * Gets expires + * * @return string */ public function getExpires() @@ -227,7 +300,9 @@ public function getExpires() /** * Sets expires + * * @param string $expires + * * @return $this */ public function setExpires($expires) @@ -239,6 +314,7 @@ public function setExpires($expires) /** * Gets folder_ids + * * @return string */ public function getFolderIds() @@ -248,7 +324,9 @@ public function getFolderIds() /** * Sets folder_ids + * * @param string $folder_ids + * * @return $this */ public function setFolderIds($folder_ids) @@ -260,6 +338,7 @@ public function setFolderIds($folder_ids) /** * Gets from_date_time + * * @return string */ public function getFromDateTime() @@ -269,7 +348,9 @@ public function getFromDateTime() /** * Sets from_date_time + * * @param string $from_date_time + * * @return $this */ public function setFromDateTime($from_date_time) @@ -281,6 +362,7 @@ public function setFromDateTime($from_date_time) /** * Gets is_template + * * @return string */ public function getIsTemplate() @@ -290,7 +372,9 @@ public function getIsTemplate() /** * Sets is_template + * * @param string $is_template + * * @return $this */ public function setIsTemplate($is_template) @@ -302,6 +386,7 @@ public function setIsTemplate($is_template) /** * Gets order + * * @return string */ public function getOrder() @@ -311,7 +396,9 @@ public function getOrder() /** * Sets order + * * @param string $order + * * @return $this */ public function setOrder($order) @@ -323,6 +410,7 @@ public function setOrder($order) /** * Gets order_by + * * @return string */ public function getOrderBy() @@ -332,7 +420,9 @@ public function getOrderBy() /** * Sets order_by + * * @param string $order_by + * * @return $this */ public function setOrderBy($order_by) @@ -344,6 +434,7 @@ public function setOrderBy($order_by) /** * Gets search_target + * * @return string */ public function getSearchTarget() @@ -353,7 +444,9 @@ public function getSearchTarget() /** * Sets search_target + * * @param string $search_target + * * @return $this */ public function setSearchTarget($search_target) @@ -365,6 +458,7 @@ public function setSearchTarget($search_target) /** * Gets search_text + * * @return string */ public function getSearchText() @@ -374,7 +468,9 @@ public function getSearchText() /** * Sets search_text + * * @param string $search_text + * * @return $this */ public function setSearchText($search_text) @@ -386,6 +482,7 @@ public function setSearchText($search_text) /** * Gets status + * * @return string */ public function getStatus() @@ -395,7 +492,9 @@ public function getStatus() /** * 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) @@ -407,6 +506,7 @@ public function setStatus($status) /** * Gets to_date_time + * * @return string */ public function getToDateTime() @@ -416,7 +516,9 @@ public function getToDateTime() /** * Sets to_date_time + * * @param string $to_date_time Must be set to \"bearer\". + * * @return $this */ public function setToDateTime($to_date_time) @@ -427,7 +529,9 @@ public function setToDateTime($to_date_time) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -437,7 +541,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -447,8 +553,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -462,7 +570,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -472,16 +582,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FirstName.php b/src/Model/FirstName.php index 3b60f72c..c0cd1c6a 100644 --- a/src/Model/FirstName.php +++ b/src/Model/FirstName.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FirstName Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FirstName implements ArrayAccess +class FirstName implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'firstName'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -143,13 +146,125 @@ class FirstName implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -242,9 +357,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -337,9 +452,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -432,34 +547,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -553,30 +697,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -586,7 +732,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -598,6 +746,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -607,7 +756,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -619,6 +770,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -628,7 +780,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -640,6 +794,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -649,7 +804,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -661,6 +818,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -670,7 +828,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -682,6 +842,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -691,7 +852,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -703,6 +866,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -712,7 +876,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -724,6 +890,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -733,7 +900,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -745,6 +914,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -754,7 +924,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -766,6 +938,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -775,7 +948,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -787,6 +962,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -796,7 +972,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -808,6 +986,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -817,7 +996,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -829,6 +1010,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -838,7 +1020,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -850,6 +1034,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -859,7 +1044,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -871,6 +1058,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -880,7 +1068,9 @@ public function getAnchorUnits() /** * 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) @@ -892,6 +1082,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -901,7 +1092,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -913,6 +1106,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -922,7 +1116,9 @@ public function getAnchorXOffset() /** * 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) @@ -934,6 +1130,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -943,7 +1140,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -955,6 +1154,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -964,7 +1164,9 @@ public function getAnchorYOffset() /** * 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) @@ -976,6 +1178,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -985,7 +1188,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -997,6 +1202,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1006,7 +1212,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1018,6 +1226,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1027,7 +1236,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1039,6 +1250,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1048,7 +1260,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1060,6 +1274,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1069,7 +1284,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1081,6 +1298,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1090,7 +1308,9 @@ public function getConditionalParentValue() /** * 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) @@ -1102,6 +1322,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1111,7 +1332,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1123,6 +1346,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1132,7 +1356,9 @@ public function getCustomTabId() /** * 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) @@ -1144,6 +1370,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1153,7 +1380,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1165,6 +1394,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1174,7 +1404,9 @@ public function getDocumentId() /** * 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) @@ -1186,6 +1418,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1195,7 +1428,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1207,6 +1442,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1216,7 +1452,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1228,6 +1466,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1237,7 +1476,9 @@ public function getFont() /** * 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) @@ -1249,6 +1490,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1258,7 +1500,9 @@ public function getFontColor() /** * 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) @@ -1270,6 +1514,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1279,7 +1524,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1291,6 +1538,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1300,7 +1548,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1312,6 +1562,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1321,7 +1572,9 @@ public function getFontSize() /** * 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) @@ -1333,6 +1586,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1342,7 +1596,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1354,6 +1610,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1363,7 +1620,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1375,6 +1634,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1384,7 +1644,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1396,6 +1658,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1405,7 +1668,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1417,6 +1682,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1426,7 +1692,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1438,6 +1706,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1447,7 +1716,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1459,6 +1730,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1468,7 +1740,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1480,6 +1754,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1489,7 +1764,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1501,6 +1778,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1510,7 +1788,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1522,6 +1802,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1531,7 +1812,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1543,6 +1826,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1552,7 +1836,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1564,6 +1850,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1573,7 +1860,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1585,6 +1874,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1594,7 +1884,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1606,6 +1898,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1615,7 +1908,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1627,6 +1922,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1636,7 +1932,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1648,6 +1946,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1657,7 +1956,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1669,6 +1970,7 @@ public function setNameMetadata($name_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1678,7 +1980,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1690,6 +1994,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1699,7 +2004,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1711,6 +2018,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1720,7 +2028,9 @@ public function getRecipientId() /** * 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) @@ -1732,6 +2042,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1741,7 +2052,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1753,6 +2066,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1762,7 +2076,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1774,6 +2090,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1783,7 +2100,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1795,6 +2114,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1804,7 +2124,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1816,6 +2138,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1825,7 +2148,9 @@ public function getStatus() /** * 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) @@ -1837,6 +2162,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1846,7 +2172,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1858,6 +2186,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1867,7 +2196,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1879,6 +2210,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1888,7 +2220,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1900,6 +2234,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1909,7 +2244,9 @@ public function getTabId() /** * 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) @@ -1921,6 +2258,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1930,7 +2268,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1942,6 +2282,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1951,7 +2292,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1963,6 +2306,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1972,7 +2316,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1984,6 +2330,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1993,7 +2340,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2005,6 +2354,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2014,7 +2364,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2026,6 +2378,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2035,7 +2388,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2047,6 +2402,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2056,7 +2412,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2068,6 +2426,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2077,7 +2436,9 @@ public function getTemplateLocked() /** * 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) @@ -2089,6 +2450,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2098,7 +2460,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2110,6 +2474,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2119,7 +2484,9 @@ public function getTemplateRequired() /** * 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) @@ -2131,6 +2498,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2140,7 +2508,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2152,6 +2522,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2161,7 +2532,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2173,6 +2546,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2182,7 +2556,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2194,6 +2570,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2203,7 +2580,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2215,6 +2594,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2224,7 +2604,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2236,6 +2618,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2245,7 +2628,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2257,6 +2642,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2266,7 +2652,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2278,6 +2666,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2287,7 +2676,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2299,6 +2690,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2308,7 +2700,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2320,6 +2714,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2329,7 +2724,9 @@ public function getXPosition() /** * 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) @@ -2341,6 +2738,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2350,7 +2748,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2362,6 +2762,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2371,7 +2772,9 @@ public function getYPosition() /** * 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) @@ -2383,6 +2786,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2392,7 +2796,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2403,7 +2809,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2413,7 +2821,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2423,8 +2833,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2438,7 +2850,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2448,16 +2862,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Folder.php b/src/Model/Folder.php index f7bd2137..9183b81d 100644 --- a/src/Model/Folder.php +++ b/src/Model/Folder.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Folder Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Folder implements ArrayAccess +class Folder implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'folder'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -71,13 +74,53 @@ class Folder implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'filter' => null, + 'folder_id' => null, + 'folder_items' => null, + 'folders' => null, + 'has_access' => null, + 'has_sub_folders' => null, + 'item_count' => null, + 'name' => null, + 'owner' => null, + 'parent_folder_id' => null, + 'parent_folder_uri' => null, + 'sub_folder_count' => null, + 'type' => null, + 'uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -98,9 +141,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -121,9 +164,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -144,34 +187,63 @@ public static function swaggerTypes() 'uri' => 'getUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -193,30 +265,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -226,7 +300,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -238,6 +314,7 @@ public function setErrorDetails($error_details) /** * Gets filter + * * @return \DocuSign\eSign\Model\Filter */ public function getFilter() @@ -247,7 +324,9 @@ public function getFilter() /** * Sets filter - * @param \DocuSign\eSign\Model\Filter $filter + * + * @param \DocuSign\eSign\Model\Filter $filter filter + * * @return $this */ public function setFilter($filter) @@ -259,6 +338,7 @@ public function setFilter($filter) /** * Gets folder_id + * * @return string */ public function getFolderId() @@ -268,7 +348,9 @@ public function getFolderId() /** * Sets folder_id + * * @param string $folder_id + * * @return $this */ public function setFolderId($folder_id) @@ -280,6 +362,7 @@ public function setFolderId($folder_id) /** * Gets folder_items + * * @return \DocuSign\eSign\Model\FolderItemV2[] */ public function getFolderItems() @@ -289,7 +372,9 @@ public function getFolderItems() /** * Sets folder_items + * * @param \DocuSign\eSign\Model\FolderItemV2[] $folder_items A list of the envelopes in the specified folder or folders. + * * @return $this */ public function setFolderItems($folder_items) @@ -301,6 +386,7 @@ public function setFolderItems($folder_items) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -310,7 +396,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders A collection of folder objects returned in a response. + * * @return $this */ public function setFolders($folders) @@ -322,6 +410,7 @@ public function setFolders($folders) /** * Gets has_access + * * @return string */ public function getHasAccess() @@ -331,7 +420,9 @@ public function getHasAccess() /** * Sets has_access + * * @param string $has_access + * * @return $this */ public function setHasAccess($has_access) @@ -343,6 +434,7 @@ public function setHasAccess($has_access) /** * Gets has_sub_folders + * * @return string */ public function getHasSubFolders() @@ -352,7 +444,9 @@ public function getHasSubFolders() /** * Sets has_sub_folders + * * @param string $has_sub_folders + * * @return $this */ public function setHasSubFolders($has_sub_folders) @@ -364,6 +458,7 @@ public function setHasSubFolders($has_sub_folders) /** * Gets item_count + * * @return string */ public function getItemCount() @@ -373,7 +468,9 @@ public function getItemCount() /** * Sets item_count + * * @param string $item_count + * * @return $this */ public function setItemCount($item_count) @@ -385,6 +482,7 @@ public function setItemCount($item_count) /** * Gets name + * * @return string */ public function getName() @@ -394,7 +492,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -406,6 +506,7 @@ public function setName($name) /** * Gets owner + * * @return \DocuSign\eSign\Model\UserInfo */ public function getOwner() @@ -415,7 +516,9 @@ public function getOwner() /** * Sets owner - * @param \DocuSign\eSign\Model\UserInfo $owner + * + * @param \DocuSign\eSign\Model\UserInfo $owner owner + * * @return $this */ public function setOwner($owner) @@ -427,6 +530,7 @@ public function setOwner($owner) /** * Gets parent_folder_id + * * @return string */ public function getParentFolderId() @@ -436,7 +540,9 @@ public function getParentFolderId() /** * Sets parent_folder_id + * * @param string $parent_folder_id + * * @return $this */ public function setParentFolderId($parent_folder_id) @@ -448,6 +554,7 @@ public function setParentFolderId($parent_folder_id) /** * Gets parent_folder_uri + * * @return string */ public function getParentFolderUri() @@ -457,7 +564,9 @@ public function getParentFolderUri() /** * Sets parent_folder_uri + * * @param string $parent_folder_uri + * * @return $this */ public function setParentFolderUri($parent_folder_uri) @@ -469,6 +578,7 @@ public function setParentFolderUri($parent_folder_uri) /** * Gets sub_folder_count + * * @return string */ public function getSubFolderCount() @@ -478,7 +588,9 @@ public function getSubFolderCount() /** * Sets sub_folder_count + * * @param string $sub_folder_count + * * @return $this */ public function setSubFolderCount($sub_folder_count) @@ -490,6 +602,7 @@ public function setSubFolderCount($sub_folder_count) /** * Gets type + * * @return string */ public function getType() @@ -499,7 +612,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -511,6 +626,7 @@ public function setType($type) /** * Gets uri + * * @return string */ public function getUri() @@ -520,7 +636,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -531,7 +649,9 @@ public function setUri($uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -541,7 +661,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -551,8 +673,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -566,7 +690,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -576,16 +702,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FolderItemResponse.php b/src/Model/FolderItemResponse.php index 9941e02b..11212075 100644 --- a/src/Model/FolderItemResponse.php +++ b/src/Model/FolderItemResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FolderItemResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FolderItemResponse implements ArrayAccess +class FolderItemResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'folderItemResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class FolderItemResponse implements ArrayAccess 'total_rows' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'folder_items' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_rows' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_rows' => 'totalRows' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_rows' => 'setTotalRows' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_rows' => 'getTotalRows' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets folder_items + * * @return \DocuSign\eSign\Model\FolderItemV2[] */ public function getFolderItems() @@ -207,7 +276,9 @@ public function getFolderItems() /** * Sets folder_items + * * @param \DocuSign\eSign\Model\FolderItemV2[] $folder_items A list of the envelopes in the specified folder or folders. + * * @return $this */ public function setFolderItems($folder_items) @@ -219,6 +290,7 @@ public function setFolderItems($folder_items) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -228,7 +300,9 @@ public function getNextUri() /** * 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) @@ -240,6 +314,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_rows + * * @return string */ public function getTotalRows() @@ -312,7 +396,9 @@ public function getTotalRows() /** * Sets total_rows + * * @param string $total_rows + * * @return $this */ public function setTotalRows($total_rows) @@ -323,7 +409,9 @@ public function setTotalRows($total_rows) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FolderItemV2.php b/src/Model/FolderItemV2.php index 3c192796..92a805e0 100644 --- a/src/Model/FolderItemV2.php +++ b/src/Model/FolderItemV2.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FolderItemV2 Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FolderItemV2 implements ArrayAccess +class FolderItemV2 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'folderItem_v2'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -76,13 +79,58 @@ class FolderItemV2 implements ArrayAccess 'template_uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'completed_date_time' => null, + 'created_date_time' => null, + 'envelope_id' => null, + 'envelope_uri' => null, + 'expire_date_time' => null, + 'folder_id' => null, + 'folder_uri' => null, + 'is21_cfr_part11' => null, + 'owner_name' => null, + 'recipients' => null, + 'recipients_uri' => null, + 'sender_company' => null, + 'sender_email' => null, + 'sender_name' => null, + 'sender_user_id' => null, + 'sent_date_time' => null, + 'status' => null, + 'subject' => null, + 'template_id' => null, + 'template_uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -108,9 +156,9 @@ public static function swaggerTypes() 'template_uri' => 'templateUri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -136,9 +184,9 @@ public static function swaggerTypes() 'template_uri' => 'setTemplateUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -164,34 +212,63 @@ public static function swaggerTypes() 'template_uri' => 'getTemplateUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -218,30 +295,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets completed_date_time + * * @return string */ public function getCompletedDateTime() @@ -251,7 +330,9 @@ public function getCompletedDateTime() /** * Sets completed_date_time + * * @param string $completed_date_time Specifies the date and time this item was completed. + * * @return $this */ public function setCompletedDateTime($completed_date_time) @@ -263,6 +344,7 @@ public function setCompletedDateTime($completed_date_time) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -272,7 +354,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -284,6 +368,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -293,7 +378,9 @@ public function getEnvelopeId() /** * 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) @@ -305,6 +392,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -314,7 +402,9 @@ public function getEnvelopeUri() /** * Sets envelope_uri + * * @param string $envelope_uri Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. + * * @return $this */ public function setEnvelopeUri($envelope_uri) @@ -326,6 +416,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets expire_date_time + * * @return string */ public function getExpireDateTime() @@ -335,7 +426,9 @@ public function getExpireDateTime() /** * Sets expire_date_time + * * @param string $expire_date_time The date and time the envelope is set to expire. + * * @return $this */ public function setExpireDateTime($expire_date_time) @@ -347,6 +440,7 @@ public function setExpireDateTime($expire_date_time) /** * Gets folder_id + * * @return string */ public function getFolderId() @@ -356,7 +450,9 @@ public function getFolderId() /** * Sets folder_id + * * @param string $folder_id + * * @return $this */ public function setFolderId($folder_id) @@ -368,6 +464,7 @@ public function setFolderId($folder_id) /** * Gets folder_uri + * * @return string */ public function getFolderUri() @@ -377,7 +474,9 @@ public function getFolderUri() /** * Sets folder_uri + * * @param string $folder_uri + * * @return $this */ public function setFolderUri($folder_uri) @@ -389,6 +488,7 @@ public function setFolderUri($folder_uri) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -398,7 +498,9 @@ public function getIs21CfrPart11() /** * Sets is21_cfr_part11 + * * @param string $is21_cfr_part11 When set to **true**, indicates that this module is enabled on the account. + * * @return $this */ public function setIs21CfrPart11($is21_cfr_part11) @@ -410,6 +512,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets owner_name + * * @return string */ public function getOwnerName() @@ -419,7 +522,9 @@ public function getOwnerName() /** * Sets owner_name + * * @param string $owner_name + * * @return $this */ public function setOwnerName($owner_name) @@ -431,6 +536,7 @@ public function setOwnerName($owner_name) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -440,7 +546,9 @@ public function getRecipients() /** * Sets recipients - * @param \DocuSign\eSign\Model\Recipients $recipients + * + * @param \DocuSign\eSign\Model\Recipients $recipients recipients + * * @return $this */ public function setRecipients($recipients) @@ -452,6 +560,7 @@ public function setRecipients($recipients) /** * Gets recipients_uri + * * @return string */ public function getRecipientsUri() @@ -461,7 +570,9 @@ public function getRecipientsUri() /** * Sets recipients_uri + * * @param string $recipients_uri Contains a URI for an endpoint that you can use to retrieve the recipients. + * * @return $this */ public function setRecipientsUri($recipients_uri) @@ -473,6 +584,7 @@ public function setRecipientsUri($recipients_uri) /** * Gets sender_company + * * @return string */ public function getSenderCompany() @@ -482,7 +594,9 @@ public function getSenderCompany() /** * Sets sender_company + * * @param string $sender_company + * * @return $this */ public function setSenderCompany($sender_company) @@ -494,6 +608,7 @@ public function setSenderCompany($sender_company) /** * Gets sender_email + * * @return string */ public function getSenderEmail() @@ -503,7 +618,9 @@ public function getSenderEmail() /** * Sets sender_email + * * @param string $sender_email + * * @return $this */ public function setSenderEmail($sender_email) @@ -515,6 +632,7 @@ public function setSenderEmail($sender_email) /** * Gets sender_name + * * @return string */ public function getSenderName() @@ -524,7 +642,9 @@ public function getSenderName() /** * Sets sender_name + * * @param string $sender_name + * * @return $this */ public function setSenderName($sender_name) @@ -536,6 +656,7 @@ public function setSenderName($sender_name) /** * Gets sender_user_id + * * @return string */ public function getSenderUserId() @@ -545,7 +666,9 @@ public function getSenderUserId() /** * Sets sender_user_id + * * @param string $sender_user_id + * * @return $this */ public function setSenderUserId($sender_user_id) @@ -557,6 +680,7 @@ public function setSenderUserId($sender_user_id) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -566,7 +690,9 @@ public function getSentDateTime() /** * 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) @@ -578,6 +704,7 @@ public function setSentDateTime($sent_date_time) /** * Gets status + * * @return string */ public function getStatus() @@ -587,7 +714,9 @@ public function getStatus() /** * 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) @@ -599,6 +728,7 @@ public function setStatus($status) /** * Gets subject + * * @return string */ public function getSubject() @@ -608,7 +738,9 @@ public function getSubject() /** * Sets subject + * * @param string $subject + * * @return $this */ public function setSubject($subject) @@ -620,6 +752,7 @@ public function setSubject($subject) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -629,7 +762,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -641,6 +776,7 @@ public function setTemplateId($template_id) /** * Gets template_uri + * * @return string */ public function getTemplateUri() @@ -650,7 +786,9 @@ public function getTemplateUri() /** * Sets template_uri + * * @param string $template_uri + * * @return $this */ public function setTemplateUri($template_uri) @@ -661,7 +799,9 @@ public function setTemplateUri($template_uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -671,7 +811,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -681,8 +823,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -696,7 +840,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -706,16 +852,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FolderItemsResponse.php b/src/Model/FolderItemsResponse.php index 80f8c2a6..8ca78e5e 100644 --- a/src/Model/FolderItemsResponse.php +++ b/src/Model/FolderItemsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FolderItemsResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FolderItemsResponse implements ArrayAccess +class FolderItemsResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'folderItemsResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class FolderItemsResponse implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'envelopes' => null, + 'folders' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -191,7 +258,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -203,6 +272,7 @@ public function setEndPosition($end_position) /** * Gets envelopes + * * @return \DocuSign\eSign\Model\EnvelopeSummary[] */ public function getEnvelopes() @@ -212,7 +282,9 @@ public function getEnvelopes() /** * Sets envelopes + * * @param \DocuSign\eSign\Model\EnvelopeSummary[] $envelopes + * * @return $this */ public function setEnvelopes($envelopes) @@ -224,6 +296,7 @@ public function setEnvelopes($envelopes) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -233,7 +306,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders + * * @return $this */ public function setFolders($folders) @@ -245,6 +320,7 @@ public function setFolders($folders) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -254,7 +330,9 @@ public function getNextUri() /** * 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) @@ -266,6 +344,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -275,7 +354,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -287,6 +368,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -296,7 +378,9 @@ public function getResultSetSize() /** * 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) @@ -308,6 +392,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -317,7 +402,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -329,6 +416,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -338,7 +426,9 @@ public function getTotalSetSize() /** * 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) @@ -349,7 +439,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FolderSharedItem.php b/src/Model/FolderSharedItem.php index 47570567..3cb1bce9 100644 --- a/src/Model/FolderSharedItem.php +++ b/src/Model/FolderSharedItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FolderSharedItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FolderSharedItem implements ArrayAccess +class FolderSharedItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'folderSharedItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -67,13 +70,49 @@ class FolderSharedItem implements ArrayAccess 'user' => '\DocuSign\eSign\Model\UserInfo' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'folder_id' => null, + 'name' => null, + 'owner' => null, + 'parent_folder_id' => null, + 'parent_folder_uri' => null, + 'shared' => null, + 'shared_groups' => null, + 'shared_users' => null, + 'uri' => null, + 'user' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -90,9 +129,9 @@ public static function swaggerTypes() 'user' => 'user' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -109,9 +148,9 @@ public static function swaggerTypes() 'user' => 'setUser' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -128,34 +167,63 @@ public static function swaggerTypes() 'user' => 'getUser' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -173,30 +241,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -206,7 +276,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -218,6 +290,7 @@ public function setErrorDetails($error_details) /** * Gets folder_id + * * @return string */ public function getFolderId() @@ -227,7 +300,9 @@ public function getFolderId() /** * Sets folder_id + * * @param string $folder_id + * * @return $this */ public function setFolderId($folder_id) @@ -239,6 +314,7 @@ public function setFolderId($folder_id) /** * Gets name + * * @return string */ public function getName() @@ -248,7 +324,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -260,6 +338,7 @@ public function setName($name) /** * Gets owner + * * @return \DocuSign\eSign\Model\UserInfo */ public function getOwner() @@ -269,7 +348,9 @@ public function getOwner() /** * Sets owner - * @param \DocuSign\eSign\Model\UserInfo $owner + * + * @param \DocuSign\eSign\Model\UserInfo $owner owner + * * @return $this */ public function setOwner($owner) @@ -281,6 +362,7 @@ public function setOwner($owner) /** * Gets parent_folder_id + * * @return string */ public function getParentFolderId() @@ -290,7 +372,9 @@ public function getParentFolderId() /** * Sets parent_folder_id + * * @param string $parent_folder_id + * * @return $this */ public function setParentFolderId($parent_folder_id) @@ -302,6 +386,7 @@ public function setParentFolderId($parent_folder_id) /** * Gets parent_folder_uri + * * @return string */ public function getParentFolderUri() @@ -311,7 +396,9 @@ public function getParentFolderUri() /** * Sets parent_folder_uri + * * @param string $parent_folder_uri + * * @return $this */ public function setParentFolderUri($parent_folder_uri) @@ -323,6 +410,7 @@ public function setParentFolderUri($parent_folder_uri) /** * Gets shared + * * @return string */ public function getShared() @@ -332,7 +420,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -344,6 +434,7 @@ public function setShared($shared) /** * Gets shared_groups + * * @return \DocuSign\eSign\Model\MemberGroupSharedItem[] */ public function getSharedGroups() @@ -353,7 +444,9 @@ public function getSharedGroups() /** * Sets shared_groups + * * @param \DocuSign\eSign\Model\MemberGroupSharedItem[] $shared_groups + * * @return $this */ public function setSharedGroups($shared_groups) @@ -365,6 +458,7 @@ public function setSharedGroups($shared_groups) /** * Gets shared_users + * * @return \DocuSign\eSign\Model\UserSharedItem[] */ public function getSharedUsers() @@ -374,7 +468,9 @@ public function getSharedUsers() /** * Sets shared_users + * * @param \DocuSign\eSign\Model\UserSharedItem[] $shared_users + * * @return $this */ public function setSharedUsers($shared_users) @@ -386,6 +482,7 @@ public function setSharedUsers($shared_users) /** * Gets uri + * * @return string */ public function getUri() @@ -395,7 +492,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -407,6 +506,7 @@ public function setUri($uri) /** * Gets user + * * @return \DocuSign\eSign\Model\UserInfo */ public function getUser() @@ -416,7 +516,9 @@ public function getUser() /** * Sets user - * @param \DocuSign\eSign\Model\UserInfo $user + * + * @param \DocuSign\eSign\Model\UserInfo $user user + * * @return $this */ public function setUser($user) @@ -427,7 +529,9 @@ public function setUser($user) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -437,7 +541,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -447,8 +553,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -462,7 +570,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -472,16 +582,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FoldersRequest.php b/src/Model/FoldersRequest.php index b8e394b8..b4dff469 100644 --- a/src/Model/FoldersRequest.php +++ b/src/Model/FoldersRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FoldersRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FoldersRequest implements ArrayAccess +class FoldersRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'foldersRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class FoldersRequest implements ArrayAccess 'from_folder_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_ids' => null, + 'folders' => null, + 'from_folder_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'from_folder_id' => 'fromFolderId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'from_folder_id' => 'setFromFolderId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'from_folder_id' => 'getFromFolderId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_ids + * * @return string[] */ public function getEnvelopeIds() @@ -166,7 +228,9 @@ public function getEnvelopeIds() /** * Sets envelope_ids + * * @param string[] $envelope_ids + * * @return $this */ public function setEnvelopeIds($envelope_ids) @@ -178,6 +242,7 @@ public function setEnvelopeIds($envelope_ids) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -187,7 +252,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders + * * @return $this */ public function setFolders($folders) @@ -199,6 +266,7 @@ public function setFolders($folders) /** * Gets from_folder_id + * * @return string */ public function getFromFolderId() @@ -208,7 +276,9 @@ public function getFromFolderId() /** * Sets from_folder_id + * * @param string $from_folder_id The folder ID the envelope is being moved from. + * * @return $this */ public function setFromFolderId($from_folder_id) @@ -219,7 +289,9 @@ public function setFromFolderId($from_folder_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FoldersResponse.php b/src/Model/FoldersResponse.php index cd12ba3b..613d584c 100644 --- a/src/Model/FoldersResponse.php +++ b/src/Model/FoldersResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FoldersResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FoldersResponse implements ArrayAccess +class FoldersResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'foldersResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class FoldersResponse implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'envelopes' => null, + 'folders' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -191,7 +258,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -203,6 +272,7 @@ public function setEndPosition($end_position) /** * Gets envelopes + * * @return \DocuSign\eSign\Model\EnvelopeSummary[] */ public function getEnvelopes() @@ -212,7 +282,9 @@ public function getEnvelopes() /** * Sets envelopes + * * @param \DocuSign\eSign\Model\EnvelopeSummary[] $envelopes + * * @return $this */ public function setEnvelopes($envelopes) @@ -224,6 +296,7 @@ public function setEnvelopes($envelopes) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -233,7 +306,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders + * * @return $this */ public function setFolders($folders) @@ -245,6 +320,7 @@ public function setFolders($folders) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -254,7 +330,9 @@ public function getNextUri() /** * 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) @@ -266,6 +344,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -275,7 +354,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -287,6 +368,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -296,7 +378,9 @@ public function getResultSetSize() /** * 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) @@ -308,6 +392,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -317,7 +402,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -329,6 +416,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -338,7 +426,9 @@ public function getTotalSetSize() /** * 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) @@ -349,7 +439,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ForgottenPasswordInformation.php b/src/Model/ForgottenPasswordInformation.php index d70c6287..acef5754 100644 --- a/src/Model/ForgottenPasswordInformation.php +++ b/src/Model/ForgottenPasswordInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ForgottenPasswordInformation Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ForgottenPasswordInformation implements ArrayAccess +class ForgottenPasswordInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'forgottenPasswordInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,46 @@ class ForgottenPasswordInformation implements ArrayAccess 'forgotten_password_question4' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'forgotten_password_answer1' => null, + 'forgotten_password_answer2' => null, + 'forgotten_password_answer3' => null, + 'forgotten_password_answer4' => null, + 'forgotten_password_question1' => null, + 'forgotten_password_question2' => null, + 'forgotten_password_question3' => null, + 'forgotten_password_question4' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -85,9 +121,9 @@ public static function swaggerTypes() 'forgotten_password_question4' => 'forgottenPasswordQuestion4' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -101,9 +137,9 @@ public static function swaggerTypes() 'forgotten_password_question4' => 'setForgottenPasswordQuestion4' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -117,34 +153,63 @@ public static function swaggerTypes() 'forgotten_password_question4' => 'getForgottenPasswordQuestion4' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -159,30 +224,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets forgotten_password_answer1 + * * @return string */ public function getForgottenPasswordAnswer1() @@ -192,7 +259,9 @@ public function getForgottenPasswordAnswer1() /** * Sets forgotten_password_answer1 + * * @param string $forgotten_password_answer1 The answer to the first forgotten password challenge question. + * * @return $this */ public function setForgottenPasswordAnswer1($forgotten_password_answer1) @@ -204,6 +273,7 @@ public function setForgottenPasswordAnswer1($forgotten_password_answer1) /** * Gets forgotten_password_answer2 + * * @return string */ public function getForgottenPasswordAnswer2() @@ -213,7 +283,9 @@ public function getForgottenPasswordAnswer2() /** * Sets forgotten_password_answer2 + * * @param string $forgotten_password_answer2 The answer to the second forgotten password challenge question. + * * @return $this */ public function setForgottenPasswordAnswer2($forgotten_password_answer2) @@ -225,6 +297,7 @@ public function setForgottenPasswordAnswer2($forgotten_password_answer2) /** * Gets forgotten_password_answer3 + * * @return string */ public function getForgottenPasswordAnswer3() @@ -234,7 +307,9 @@ public function getForgottenPasswordAnswer3() /** * Sets forgotten_password_answer3 + * * @param string $forgotten_password_answer3 The answer to the third forgotten password challenge question. + * * @return $this */ public function setForgottenPasswordAnswer3($forgotten_password_answer3) @@ -246,6 +321,7 @@ public function setForgottenPasswordAnswer3($forgotten_password_answer3) /** * Gets forgotten_password_answer4 + * * @return string */ public function getForgottenPasswordAnswer4() @@ -255,7 +331,9 @@ public function getForgottenPasswordAnswer4() /** * Sets forgotten_password_answer4 + * * @param string $forgotten_password_answer4 The answer to the fourth forgotten password challenge question. + * * @return $this */ public function setForgottenPasswordAnswer4($forgotten_password_answer4) @@ -267,6 +345,7 @@ public function setForgottenPasswordAnswer4($forgotten_password_answer4) /** * Gets forgotten_password_question1 + * * @return string */ public function getForgottenPasswordQuestion1() @@ -276,7 +355,9 @@ public function getForgottenPasswordQuestion1() /** * Sets forgotten_password_question1 + * * @param string $forgotten_password_question1 The first challenge question presented to a user who has forgotten their password. + * * @return $this */ public function setForgottenPasswordQuestion1($forgotten_password_question1) @@ -288,6 +369,7 @@ public function setForgottenPasswordQuestion1($forgotten_password_question1) /** * Gets forgotten_password_question2 + * * @return string */ public function getForgottenPasswordQuestion2() @@ -297,7 +379,9 @@ public function getForgottenPasswordQuestion2() /** * Sets forgotten_password_question2 + * * @param string $forgotten_password_question2 The second challenge question presented to a user who has forgotten their password. + * * @return $this */ public function setForgottenPasswordQuestion2($forgotten_password_question2) @@ -309,6 +393,7 @@ public function setForgottenPasswordQuestion2($forgotten_password_question2) /** * Gets forgotten_password_question3 + * * @return string */ public function getForgottenPasswordQuestion3() @@ -318,7 +403,9 @@ public function getForgottenPasswordQuestion3() /** * Sets forgotten_password_question3 + * * @param string $forgotten_password_question3 The third challenge question presented to a user who has forgotten their password. + * * @return $this */ public function setForgottenPasswordQuestion3($forgotten_password_question3) @@ -330,6 +417,7 @@ public function setForgottenPasswordQuestion3($forgotten_password_question3) /** * Gets forgotten_password_question4 + * * @return string */ public function getForgottenPasswordQuestion4() @@ -339,7 +427,9 @@ public function getForgottenPasswordQuestion4() /** * Sets forgotten_password_question4 + * * @param string $forgotten_password_question4 The fourth challenge question presented to a user who has forgotten their password. + * * @return $this */ public function setForgottenPasswordQuestion4($forgotten_password_question4) @@ -350,7 +440,9 @@ public function setForgottenPasswordQuestion4($forgotten_password_question4) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -360,7 +452,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -370,8 +464,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -385,7 +481,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -395,16 +493,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FormDataItem.php b/src/Model/FormDataItem.php index 6362c7ce..38168ea3 100644 --- a/src/Model/FormDataItem.php +++ b/src/Model/FormDataItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FormDataItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FormDataItem implements ArrayAccess +class FormDataItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'formDataItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class FormDataItem implements ArrayAccess 'value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'list_selected_value' => null, + 'name' => null, + 'original_value' => null, + 'value' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'value' => 'value' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'value' => 'setValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'value' => 'getValue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -176,7 +240,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -188,6 +254,7 @@ public function setErrorDetails($error_details) /** * Gets list_selected_value + * * @return string */ public function getListSelectedValue() @@ -197,7 +264,9 @@ public function getListSelectedValue() /** * Sets list_selected_value + * * @param string $list_selected_value + * * @return $this */ public function setListSelectedValue($list_selected_value) @@ -209,6 +278,7 @@ public function setListSelectedValue($list_selected_value) /** * Gets name + * * @return string */ public function getName() @@ -218,7 +288,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -230,6 +302,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -239,7 +312,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -251,6 +326,7 @@ public function setOriginalValue($original_value) /** * Gets value + * * @return string */ public function getValue() @@ -260,7 +336,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -271,7 +349,9 @@ public function setValue($value) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FormulaTab.php b/src/Model/FormulaTab.php index 105ea82e..490a3b76 100644 --- a/src/Model/FormulaTab.php +++ b/src/Model/FormulaTab.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FormulaTab Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FormulaTab implements ArrayAccess +class FormulaTab implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'formulaTab'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -176,13 +179,158 @@ class FormulaTab implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conceal_value_on_document' => null, + 'conceal_value_on_document_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'disable_auto_size' => null, + 'disable_auto_size_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'formula' => null, + 'formula_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'hidden' => null, + 'hidden_metadata' => null, + 'is_payment_amount' => null, + 'is_payment_amount_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'max_length' => null, + 'max_length_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'original_value' => null, + 'original_value_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'payment_details' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'require_all' => null, + 'require_all_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'round_decimal_places' => null, + 'round_decimal_places_metadata' => null, + 'sender_required' => null, + 'sender_required_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'validation_message' => null, + 'validation_message_metadata' => null, + 'validation_pattern' => null, + 'validation_pattern_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -308,9 +456,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -436,9 +584,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -564,34 +712,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -718,30 +895,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -751,7 +930,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -763,6 +944,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -772,7 +954,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -784,6 +968,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -793,7 +978,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -805,6 +992,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -814,7 +1002,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -826,6 +1016,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -835,7 +1026,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -847,6 +1040,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -856,7 +1050,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -868,6 +1064,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -877,7 +1074,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -889,6 +1088,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -898,7 +1098,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -910,6 +1112,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -919,7 +1122,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -931,6 +1136,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -940,7 +1146,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -952,6 +1160,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -961,7 +1170,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -973,6 +1184,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -982,7 +1194,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -994,6 +1208,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -1003,7 +1218,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -1015,6 +1232,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -1024,7 +1242,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -1036,6 +1256,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -1045,7 +1266,9 @@ public function getAnchorUnits() /** * 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) @@ -1057,6 +1280,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -1066,7 +1290,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -1078,6 +1304,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -1087,7 +1314,9 @@ public function getAnchorXOffset() /** * 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) @@ -1099,6 +1328,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1108,7 +1338,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1120,6 +1352,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1129,7 +1362,9 @@ public function getAnchorYOffset() /** * 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) @@ -1141,6 +1376,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1150,7 +1386,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1162,6 +1400,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1171,7 +1410,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1183,6 +1424,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1192,7 +1434,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1204,6 +1448,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -1213,7 +1458,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -1225,6 +1472,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conceal_value_on_document_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConcealValueOnDocumentMetadata() @@ -1234,7 +1482,9 @@ public function getConcealValueOnDocumentMetadata() /** * Sets conceal_value_on_document_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata conceal_value_on_document_metadata + * * @return $this */ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_metadata) @@ -1246,6 +1496,7 @@ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_met /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1255,7 +1506,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1267,6 +1520,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1276,7 +1530,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1288,6 +1544,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1297,7 +1554,9 @@ public function getConditionalParentValue() /** * 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) @@ -1309,6 +1568,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1318,7 +1578,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1330,6 +1592,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1339,7 +1602,9 @@ public function getCustomTabId() /** * 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) @@ -1351,6 +1616,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1360,7 +1626,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1372,6 +1640,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -1381,7 +1650,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -1393,6 +1664,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets disable_auto_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisableAutoSizeMetadata() @@ -1402,7 +1674,9 @@ public function getDisableAutoSizeMetadata() /** * Sets disable_auto_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata disable_auto_size_metadata + * * @return $this */ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) @@ -1414,6 +1688,7 @@ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1423,7 +1698,9 @@ public function getDocumentId() /** * 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) @@ -1435,6 +1712,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1444,7 +1722,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1456,6 +1736,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1465,7 +1746,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1477,6 +1760,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1486,7 +1770,9 @@ public function getFont() /** * 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) @@ -1498,6 +1784,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1507,7 +1794,9 @@ public function getFontColor() /** * 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) @@ -1519,6 +1808,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1528,7 +1818,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1540,6 +1832,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1549,7 +1842,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1561,6 +1856,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1570,7 +1866,9 @@ public function getFontSize() /** * 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) @@ -1582,6 +1880,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1591,7 +1890,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1603,6 +1904,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1612,7 +1914,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1624,6 +1928,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1633,7 +1938,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1645,6 +1952,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1654,7 +1962,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1666,6 +1976,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1675,7 +1986,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1687,6 +2000,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1696,7 +2010,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1708,6 +2024,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1717,7 +2034,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1729,6 +2048,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets formula + * * @return string */ public function getFormula() @@ -1738,7 +2058,9 @@ public function getFormula() /** * Sets formula + * * @param string $formula The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] + * * @return $this */ public function setFormula($formula) @@ -1750,6 +2072,7 @@ public function setFormula($formula) /** * Gets formula_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormulaMetadata() @@ -1759,7 +2082,9 @@ public function getFormulaMetadata() /** * Sets formula_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $formula_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $formula_metadata formula_metadata + * * @return $this */ public function setFormulaMetadata($formula_metadata) @@ -1771,6 +2096,7 @@ public function setFormulaMetadata($formula_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1780,7 +2106,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1792,6 +2120,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1801,7 +2130,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1813,6 +2144,7 @@ public function setHeightMetadata($height_metadata) /** * Gets hidden + * * @return string */ public function getHidden() @@ -1822,7 +2154,9 @@ public function getHidden() /** * Sets hidden + * * @param string $hidden + * * @return $this */ public function setHidden($hidden) @@ -1834,6 +2168,7 @@ public function setHidden($hidden) /** * Gets hidden_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHiddenMetadata() @@ -1843,7 +2178,9 @@ public function getHiddenMetadata() /** * Sets hidden_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $hidden_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $hidden_metadata hidden_metadata + * * @return $this */ public function setHiddenMetadata($hidden_metadata) @@ -1855,6 +2192,7 @@ public function setHiddenMetadata($hidden_metadata) /** * Gets is_payment_amount + * * @return string */ public function getIsPaymentAmount() @@ -1864,7 +2202,9 @@ public function getIsPaymentAmount() /** * Sets is_payment_amount + * * @param string $is_payment_amount When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. + * * @return $this */ public function setIsPaymentAmount($is_payment_amount) @@ -1876,6 +2216,7 @@ public function setIsPaymentAmount($is_payment_amount) /** * Gets is_payment_amount_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIsPaymentAmountMetadata() @@ -1885,7 +2226,9 @@ public function getIsPaymentAmountMetadata() /** * Sets is_payment_amount_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $is_payment_amount_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $is_payment_amount_metadata is_payment_amount_metadata + * * @return $this */ public function setIsPaymentAmountMetadata($is_payment_amount_metadata) @@ -1897,6 +2240,7 @@ public function setIsPaymentAmountMetadata($is_payment_amount_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1906,7 +2250,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1918,6 +2264,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1927,7 +2274,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1939,6 +2288,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1948,7 +2298,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1960,6 +2312,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1969,7 +2322,9 @@ public function getLocked() /** * 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) @@ -1981,6 +2336,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1990,7 +2346,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -2002,6 +2360,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets max_length + * * @return string */ public function getMaxLength() @@ -2011,7 +2370,9 @@ public function getMaxLength() /** * Sets max_length + * * @param string $max_length An optional value that describes the maximum length of the property when the property is a string. + * * @return $this */ public function setMaxLength($max_length) @@ -2023,6 +2384,7 @@ public function setMaxLength($max_length) /** * Gets max_length_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaxLengthMetadata() @@ -2032,7 +2394,9 @@ public function getMaxLengthMetadata() /** * Sets max_length_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata max_length_metadata + * * @return $this */ public function setMaxLengthMetadata($max_length_metadata) @@ -2044,6 +2408,7 @@ public function setMaxLengthMetadata($max_length_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -2053,7 +2418,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -2065,6 +2432,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -2074,7 +2442,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -2086,6 +2456,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -2095,7 +2466,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -2107,6 +2480,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -2116,7 +2490,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -2128,6 +2504,7 @@ public function setNameMetadata($name_metadata) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -2137,7 +2514,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -2149,6 +2528,7 @@ public function setOriginalValue($original_value) /** * Gets original_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOriginalValueMetadata() @@ -2158,7 +2538,9 @@ public function getOriginalValueMetadata() /** * Sets original_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata original_value_metadata + * * @return $this */ public function setOriginalValueMetadata($original_value_metadata) @@ -2170,6 +2552,7 @@ public function setOriginalValueMetadata($original_value_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -2179,7 +2562,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -2191,6 +2576,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -2200,7 +2586,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -2212,6 +2600,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets payment_details + * * @return \DocuSign\eSign\Model\PaymentDetails */ public function getPaymentDetails() @@ -2221,7 +2610,9 @@ public function getPaymentDetails() /** * Sets payment_details - * @param \DocuSign\eSign\Model\PaymentDetails $payment_details + * + * @param \DocuSign\eSign\Model\PaymentDetails $payment_details payment_details + * * @return $this */ public function setPaymentDetails($payment_details) @@ -2233,6 +2624,7 @@ public function setPaymentDetails($payment_details) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -2242,7 +2634,9 @@ public function getRecipientId() /** * 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) @@ -2254,6 +2648,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -2263,7 +2658,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -2275,6 +2672,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -2284,7 +2682,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -2296,6 +2696,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -2305,7 +2706,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -2317,6 +2720,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -2326,7 +2730,9 @@ public function getRequireAll() /** * 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) @@ -2338,6 +2744,7 @@ public function setRequireAll($require_all) /** * Gets require_all_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireAllMetadata() @@ -2347,7 +2754,9 @@ public function getRequireAllMetadata() /** * Sets require_all_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata require_all_metadata + * * @return $this */ public function setRequireAllMetadata($require_all_metadata) @@ -2359,6 +2768,7 @@ public function setRequireAllMetadata($require_all_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -2368,7 +2778,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -2380,6 +2792,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -2389,7 +2802,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2401,6 +2816,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -2410,7 +2826,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -2422,6 +2840,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -2431,7 +2850,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -2443,6 +2864,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets round_decimal_places + * * @return string */ public function getRoundDecimalPlaces() @@ -2452,7 +2874,9 @@ public function getRoundDecimalPlaces() /** * Sets round_decimal_places + * * @param string $round_decimal_places + * * @return $this */ public function setRoundDecimalPlaces($round_decimal_places) @@ -2464,6 +2888,7 @@ public function setRoundDecimalPlaces($round_decimal_places) /** * Gets round_decimal_places_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoundDecimalPlacesMetadata() @@ -2473,7 +2898,9 @@ public function getRoundDecimalPlacesMetadata() /** * Sets round_decimal_places_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $round_decimal_places_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $round_decimal_places_metadata round_decimal_places_metadata + * * @return $this */ public function setRoundDecimalPlacesMetadata($round_decimal_places_metadata) @@ -2485,6 +2912,7 @@ public function setRoundDecimalPlacesMetadata($round_decimal_places_metadata) /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -2494,7 +2922,9 @@ public function getSenderRequired() /** * 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. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + * * @return $this */ public function setSenderRequired($sender_required) @@ -2506,6 +2936,7 @@ public function setSenderRequired($sender_required) /** * Gets sender_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderRequiredMetadata() @@ -2515,7 +2946,9 @@ public function getSenderRequiredMetadata() /** * Sets sender_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata sender_required_metadata + * * @return $this */ public function setSenderRequiredMetadata($sender_required_metadata) @@ -2527,6 +2960,7 @@ public function setSenderRequiredMetadata($sender_required_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -2536,7 +2970,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -2548,6 +2984,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -2557,7 +2994,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -2569,6 +3008,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2578,7 +3018,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2590,6 +3032,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2599,7 +3042,9 @@ public function getStatus() /** * 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) @@ -2611,6 +3056,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2620,7 +3066,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2632,6 +3080,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2641,7 +3090,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2653,6 +3104,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2662,7 +3114,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2674,6 +3128,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2683,7 +3138,9 @@ public function getTabId() /** * 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) @@ -2695,6 +3152,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2704,7 +3162,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2716,6 +3176,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2725,7 +3186,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2737,6 +3200,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2746,7 +3210,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2758,6 +3224,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2767,7 +3234,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2779,6 +3248,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2788,7 +3258,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2800,6 +3272,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2809,7 +3282,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2821,6 +3296,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2830,7 +3306,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2842,6 +3320,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2851,7 +3330,9 @@ public function getTemplateLocked() /** * 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) @@ -2863,6 +3344,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2872,7 +3354,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2884,6 +3368,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2893,7 +3378,9 @@ public function getTemplateRequired() /** * 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) @@ -2905,6 +3392,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2914,7 +3402,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2926,6 +3416,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2935,7 +3426,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2947,6 +3440,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2956,7 +3450,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2968,6 +3464,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2977,7 +3474,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2989,6 +3488,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2998,7 +3498,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -3010,6 +3512,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -3019,7 +3522,9 @@ public function getValidationMessage() /** * Sets validation_message + * * @param string $validation_message The message displayed if the custom tab fails input validation (either custom of embedded). + * * @return $this */ public function setValidationMessage($validation_message) @@ -3031,6 +3536,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_message_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationMessageMetadata() @@ -3040,7 +3546,9 @@ public function getValidationMessageMetadata() /** * Sets validation_message_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata validation_message_metadata + * * @return $this */ public function setValidationMessageMetadata($validation_message_metadata) @@ -3052,6 +3560,7 @@ public function setValidationMessageMetadata($validation_message_metadata) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -3061,7 +3570,9 @@ public function getValidationPattern() /** * Sets validation_pattern + * * @param string $validation_pattern A regular expression used to validate input for the tab. + * * @return $this */ public function setValidationPattern($validation_pattern) @@ -3073,6 +3584,7 @@ public function setValidationPattern($validation_pattern) /** * Gets validation_pattern_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationPatternMetadata() @@ -3082,7 +3594,9 @@ public function getValidationPatternMetadata() /** * Sets validation_pattern_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata validation_pattern_metadata + * * @return $this */ public function setValidationPatternMetadata($validation_pattern_metadata) @@ -3094,6 +3608,7 @@ public function setValidationPatternMetadata($validation_pattern_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -3103,7 +3618,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -3115,6 +3632,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -3124,7 +3642,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -3136,6 +3656,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -3145,7 +3666,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -3157,6 +3680,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -3166,7 +3690,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -3178,6 +3704,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -3187,7 +3714,9 @@ public function getXPosition() /** * 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) @@ -3199,6 +3728,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -3208,7 +3738,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -3220,6 +3752,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -3229,7 +3762,9 @@ public function getYPosition() /** * 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) @@ -3241,6 +3776,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -3250,7 +3786,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -3261,7 +3799,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -3271,7 +3811,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -3281,8 +3823,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -3296,7 +3840,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -3306,16 +3852,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/FullName.php b/src/Model/FullName.php index eba8ef3b..2c145f3c 100644 --- a/src/Model/FullName.php +++ b/src/Model/FullName.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FullName Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FullName implements ArrayAccess +class FullName implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'fullName'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -143,13 +146,125 @@ class FullName implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -242,9 +357,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -337,9 +452,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -432,34 +547,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -553,30 +697,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -586,7 +732,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -598,6 +746,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -607,7 +756,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -619,6 +770,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -628,7 +780,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -640,6 +794,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -649,7 +804,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -661,6 +818,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -670,7 +828,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -682,6 +842,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -691,7 +852,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -703,6 +866,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -712,7 +876,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -724,6 +890,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -733,7 +900,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -745,6 +914,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -754,7 +924,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -766,6 +938,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -775,7 +948,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -787,6 +962,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -796,7 +972,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -808,6 +986,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -817,7 +996,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -829,6 +1010,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -838,7 +1020,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -850,6 +1034,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -859,7 +1044,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -871,6 +1058,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -880,7 +1068,9 @@ public function getAnchorUnits() /** * 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) @@ -892,6 +1082,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -901,7 +1092,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -913,6 +1106,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -922,7 +1116,9 @@ public function getAnchorXOffset() /** * 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) @@ -934,6 +1130,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -943,7 +1140,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -955,6 +1154,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -964,7 +1164,9 @@ public function getAnchorYOffset() /** * 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) @@ -976,6 +1178,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -985,7 +1188,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -997,6 +1202,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1006,7 +1212,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1018,6 +1226,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1027,7 +1236,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1039,6 +1250,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1048,7 +1260,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1060,6 +1274,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1069,7 +1284,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1081,6 +1298,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1090,7 +1308,9 @@ public function getConditionalParentValue() /** * 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) @@ -1102,6 +1322,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1111,7 +1332,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1123,6 +1346,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1132,7 +1356,9 @@ public function getCustomTabId() /** * 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) @@ -1144,6 +1370,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1153,7 +1380,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1165,6 +1394,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1174,7 +1404,9 @@ public function getDocumentId() /** * 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) @@ -1186,6 +1418,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1195,7 +1428,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1207,6 +1442,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1216,7 +1452,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1228,6 +1466,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1237,7 +1476,9 @@ public function getFont() /** * 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) @@ -1249,6 +1490,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1258,7 +1500,9 @@ public function getFontColor() /** * 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) @@ -1270,6 +1514,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1279,7 +1524,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1291,6 +1538,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1300,7 +1548,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1312,6 +1562,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1321,7 +1572,9 @@ public function getFontSize() /** * 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) @@ -1333,6 +1586,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1342,7 +1596,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1354,6 +1610,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1363,7 +1620,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1375,6 +1634,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1384,7 +1644,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1396,6 +1658,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1405,7 +1668,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1417,6 +1682,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1426,7 +1692,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1438,6 +1706,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1447,7 +1716,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1459,6 +1730,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1468,7 +1740,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1480,6 +1754,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1489,7 +1764,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1501,6 +1778,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1510,7 +1788,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1522,6 +1802,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1531,7 +1812,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1543,6 +1826,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1552,7 +1836,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1564,6 +1850,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1573,7 +1860,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1585,6 +1874,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1594,7 +1884,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1606,6 +1898,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1615,7 +1908,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1627,6 +1922,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1636,7 +1932,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1648,6 +1946,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1657,7 +1956,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1669,6 +1970,7 @@ public function setNameMetadata($name_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1678,7 +1980,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1690,6 +1994,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1699,7 +2004,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1711,6 +2018,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1720,7 +2028,9 @@ public function getRecipientId() /** * 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) @@ -1732,6 +2042,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1741,7 +2052,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1753,6 +2066,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1762,7 +2076,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1774,6 +2090,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1783,7 +2100,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1795,6 +2114,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1804,7 +2124,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1816,6 +2138,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1825,7 +2148,9 @@ public function getStatus() /** * 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) @@ -1837,6 +2162,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1846,7 +2172,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1858,6 +2186,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1867,7 +2196,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1879,6 +2210,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1888,7 +2220,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1900,6 +2234,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1909,7 +2244,9 @@ public function getTabId() /** * 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) @@ -1921,6 +2258,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1930,7 +2268,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1942,6 +2282,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1951,7 +2292,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1963,6 +2306,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1972,7 +2316,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1984,6 +2330,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1993,7 +2340,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2005,6 +2354,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2014,7 +2364,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2026,6 +2378,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2035,7 +2388,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2047,6 +2402,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2056,7 +2412,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2068,6 +2426,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2077,7 +2436,9 @@ public function getTemplateLocked() /** * 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) @@ -2089,6 +2450,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2098,7 +2460,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2110,6 +2474,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2119,7 +2484,9 @@ public function getTemplateRequired() /** * 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) @@ -2131,6 +2498,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2140,7 +2508,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2152,6 +2522,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2161,7 +2532,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2173,6 +2546,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2182,7 +2556,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2194,6 +2570,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2203,7 +2580,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2215,6 +2594,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2224,7 +2604,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2236,6 +2618,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2245,7 +2628,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2257,6 +2642,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2266,7 +2652,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2278,6 +2666,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2287,7 +2676,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2299,6 +2690,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2308,7 +2700,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2320,6 +2714,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2329,7 +2724,9 @@ public function getXPosition() /** * 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) @@ -2341,6 +2738,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2350,7 +2748,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2362,6 +2762,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2371,7 +2772,9 @@ public function getYPosition() /** * 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) @@ -2383,6 +2786,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2392,7 +2796,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2403,7 +2809,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2413,7 +2821,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2423,8 +2833,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2438,7 +2850,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2448,16 +2862,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/GraphicsContext.php b/src/Model/GraphicsContext.php index 653826e1..71f9bc4f 100644 --- a/src/Model/GraphicsContext.php +++ b/src/Model/GraphicsContext.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * GraphicsContext Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class GraphicsContext implements ArrayAccess +class GraphicsContext implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'graphicsContext'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class GraphicsContext implements ArrayAccess 'line_weight' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'fill_color' => null, + 'line_color' => null, + 'line_weight' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'line_weight' => 'lineWeight' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'line_weight' => 'setLineWeight' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'line_weight' => 'getLineWeight' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets fill_color + * * @return string */ public function getFillColor() @@ -166,7 +228,9 @@ public function getFillColor() /** * Sets fill_color + * * @param string $fill_color + * * @return $this */ public function setFillColor($fill_color) @@ -178,6 +242,7 @@ public function setFillColor($fill_color) /** * Gets line_color + * * @return string */ public function getLineColor() @@ -187,7 +252,9 @@ public function getLineColor() /** * Sets line_color + * * @param string $line_color + * * @return $this */ public function setLineColor($line_color) @@ -199,6 +266,7 @@ public function setLineColor($line_color) /** * Gets line_weight + * * @return string */ public function getLineWeight() @@ -208,7 +276,9 @@ public function getLineWeight() /** * Sets line_weight + * * @param string $line_weight + * * @return $this */ public function setLineWeight($line_weight) @@ -219,7 +289,9 @@ public function setLineWeight($line_weight) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Group.php b/src/Model/Group.php index 3034981f..8fd67236 100644 --- a/src/Model/Group.php +++ b/src/Model/Group.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Group Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Group implements ArrayAccess +class Group implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'group'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class Group implements ArrayAccess 'users_count' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'group_id' => null, + 'group_name' => null, + 'group_type' => null, + 'permission_profile_id' => null, + 'users' => null, + 'users_count' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'users_count' => 'usersCount' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'users_count' => 'setUsersCount' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'users_count' => 'getUsersCount' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -186,7 +252,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -198,6 +266,7 @@ public function setErrorDetails($error_details) /** * Gets group_id + * * @return string */ public function getGroupId() @@ -207,7 +276,9 @@ public function getGroupId() /** * Sets group_id + * * @param string $group_id The DocuSign group ID for the group. + * * @return $this */ public function setGroupId($group_id) @@ -219,6 +290,7 @@ public function setGroupId($group_id) /** * Gets group_name + * * @return string */ public function getGroupName() @@ -228,7 +300,9 @@ public function getGroupName() /** * Sets group_name + * * @param string $group_name The name of the group. + * * @return $this */ public function setGroupName($group_name) @@ -240,6 +314,7 @@ public function setGroupName($group_name) /** * Gets group_type + * * @return string */ public function getGroupType() @@ -249,7 +324,9 @@ public function getGroupType() /** * Sets group_type + * * @param string $group_type The group type. + * * @return $this */ public function setGroupType($group_type) @@ -261,6 +338,7 @@ public function setGroupType($group_type) /** * Gets permission_profile_id + * * @return string */ public function getPermissionProfileId() @@ -270,7 +348,9 @@ public function getPermissionProfileId() /** * Sets permission_profile_id + * * @param string $permission_profile_id The ID of the permission profile associated with the group. + * * @return $this */ public function setPermissionProfileId($permission_profile_id) @@ -282,6 +362,7 @@ public function setPermissionProfileId($permission_profile_id) /** * Gets users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getUsers() @@ -291,7 +372,9 @@ public function getUsers() /** * Sets users + * * @param \DocuSign\eSign\Model\UserInfo[] $users + * * @return $this */ public function setUsers($users) @@ -303,6 +386,7 @@ public function setUsers($users) /** * Gets users_count + * * @return string */ public function getUsersCount() @@ -312,7 +396,9 @@ public function getUsersCount() /** * Sets users_count + * * @param string $users_count + * * @return $this */ public function setUsersCount($users_count) @@ -323,7 +409,9 @@ public function setUsersCount($users_count) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/GroupInformation.php b/src/Model/GroupInformation.php index 38a1a2c0..d0e76023 100644 --- a/src/Model/GroupInformation.php +++ b/src/Model/GroupInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * GroupInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class GroupInformation implements ArrayAccess +class GroupInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'groupInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class GroupInformation implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'groups' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets groups + * * @return \DocuSign\eSign\Model\Group[] */ public function getGroups() @@ -207,7 +276,9 @@ public function getGroups() /** * Sets groups + * * @param \DocuSign\eSign\Model\Group[] $groups A collection group objects containing information about the groups returned. + * * @return $this */ public function setGroups($groups) @@ -219,6 +290,7 @@ public function setGroups($groups) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -228,7 +300,9 @@ public function getNextUri() /** * 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) @@ -240,6 +314,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/IdCheckConfiguration.php b/src/Model/IdCheckConfiguration.php index 956a792a..e79d632a 100644 --- a/src/Model/IdCheckConfiguration.php +++ b/src/Model/IdCheckConfiguration.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * IdCheckConfiguration Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class IdCheckConfiguration implements ArrayAccess +class IdCheckConfiguration implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'idCheckConfiguration'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class IdCheckConfiguration implements ArrayAccess 'name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'auth_steps' => null, + 'is_default' => null, + 'name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'name' => 'name' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'name' => 'setName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'name' => 'getName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets auth_steps + * * @return \DocuSign\eSign\Model\IdCheckSecurityStep[] */ public function getAuthSteps() @@ -166,7 +228,9 @@ public function getAuthSteps() /** * Sets auth_steps + * * @param \DocuSign\eSign\Model\IdCheckSecurityStep[] $auth_steps + * * @return $this */ public function setAuthSteps($auth_steps) @@ -178,6 +242,7 @@ public function setAuthSteps($auth_steps) /** * Gets is_default + * * @return string */ public function getIsDefault() @@ -187,7 +252,9 @@ public function getIsDefault() /** * Sets is_default + * * @param string $is_default + * * @return $this */ public function setIsDefault($is_default) @@ -199,6 +266,7 @@ public function setIsDefault($is_default) /** * Gets name + * * @return string */ public function getName() @@ -208,7 +276,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -219,7 +289,9 @@ public function setName($name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/IdCheckInformationInput.php b/src/Model/IdCheckInformationInput.php index b303d55f..380ae063 100644 --- a/src/Model/IdCheckInformationInput.php +++ b/src/Model/IdCheckInformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * IdCheckInformationInput Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class IdCheckInformationInput implements ArrayAccess +class IdCheckInformationInput implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'idCheckInformationInput'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,42 @@ class IdCheckInformationInput implements ArrayAccess 'ssn9_information_input' => '\DocuSign\eSign\Model\Ssn9InformationInput' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address_information_input' => null, + 'dob_information_input' => null, + 'ssn4_information_input' => null, + 'ssn9_information_input' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -77,9 +109,9 @@ public static function swaggerTypes() 'ssn9_information_input' => 'ssn9InformationInput' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -89,9 +121,9 @@ public static function swaggerTypes() 'ssn9_information_input' => 'setSsn9InformationInput' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -101,34 +133,63 @@ public static function swaggerTypes() 'ssn9_information_input' => 'getSsn9InformationInput' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -139,30 +200,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address_information_input + * * @return \DocuSign\eSign\Model\AddressInformationInput */ public function getAddressInformationInput() @@ -172,7 +235,9 @@ public function getAddressInformationInput() /** * Sets address_information_input - * @param \DocuSign\eSign\Model\AddressInformationInput $address_information_input + * + * @param \DocuSign\eSign\Model\AddressInformationInput $address_information_input address_information_input + * * @return $this */ public function setAddressInformationInput($address_information_input) @@ -184,6 +249,7 @@ public function setAddressInformationInput($address_information_input) /** * Gets dob_information_input + * * @return \DocuSign\eSign\Model\DobInformationInput */ public function getDobInformationInput() @@ -193,7 +259,9 @@ public function getDobInformationInput() /** * Sets dob_information_input - * @param \DocuSign\eSign\Model\DobInformationInput $dob_information_input + * + * @param \DocuSign\eSign\Model\DobInformationInput $dob_information_input dob_information_input + * * @return $this */ public function setDobInformationInput($dob_information_input) @@ -205,6 +273,7 @@ public function setDobInformationInput($dob_information_input) /** * Gets ssn4_information_input + * * @return \DocuSign\eSign\Model\Ssn4InformationInput */ public function getSsn4InformationInput() @@ -214,7 +283,9 @@ public function getSsn4InformationInput() /** * Sets ssn4_information_input - * @param \DocuSign\eSign\Model\Ssn4InformationInput $ssn4_information_input + * + * @param \DocuSign\eSign\Model\Ssn4InformationInput $ssn4_information_input ssn4_information_input + * * @return $this */ public function setSsn4InformationInput($ssn4_information_input) @@ -226,6 +297,7 @@ public function setSsn4InformationInput($ssn4_information_input) /** * Gets ssn9_information_input + * * @return \DocuSign\eSign\Model\Ssn9InformationInput */ public function getSsn9InformationInput() @@ -235,7 +307,9 @@ public function getSsn9InformationInput() /** * Sets ssn9_information_input - * @param \DocuSign\eSign\Model\Ssn9InformationInput $ssn9_information_input + * + * @param \DocuSign\eSign\Model\Ssn9InformationInput $ssn9_information_input ssn9_information_input + * * @return $this */ public function setSsn9InformationInput($ssn9_information_input) @@ -246,7 +320,9 @@ public function setSsn9InformationInput($ssn9_information_input) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -256,7 +332,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -266,8 +344,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -281,7 +361,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -291,16 +373,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/IdCheckSecurityStep.php b/src/Model/IdCheckSecurityStep.php index 6f882d31..147f0497 100644 --- a/src/Model/IdCheckSecurityStep.php +++ b/src/Model/IdCheckSecurityStep.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * IdCheckSecurityStep Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class IdCheckSecurityStep implements ArrayAccess +class IdCheckSecurityStep implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'idCheckSecurityStep'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'auth_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'auth_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'auth_type' => 'authType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'auth_type' => 'setAuthType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'auth_type' => 'getAuthType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets auth_type + * * @return string */ public function getAuthType() @@ -156,7 +216,9 @@ public function getAuthType() /** * Sets auth_type + * * @param string $auth_type + * * @return $this */ public function setAuthType($auth_type) @@ -167,7 +229,9 @@ public function setAuthType($auth_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/InPersonSigner.php b/src/Model/InPersonSigner.php index a5894cd4..9dc64291 100644 --- a/src/Model/InPersonSigner.php +++ b/src/Model/InPersonSigner.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * InPersonSigner Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class InPersonSigner implements ArrayAccess +class InPersonSigner implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'inPersonSigner'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -88,6 +91,7 @@ class InPersonSigner implements ArrayAccess 'id_check_configuration_name' => 'string', 'id_check_configuration_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'in_person_signing_type' => 'string', 'in_person_signing_type_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', @@ -146,13 +150,129 @@ class InPersonSigner implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'allow_system_override_for_locked_recipient' => null, + 'auto_navigation' => null, + 'can_sign_offline' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'creation_reason' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'default_recipient' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email' => null, + 'email_metadata' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'host_email' => null, + 'host_email_metadata' => null, + 'host_name' => null, + 'host_name_metadata' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'in_person_signing_type' => null, + 'in_person_signing_type_metadata' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'name_metadata' => null, + 'notary_host' => null, + 'note' => null, + 'note_metadata' => null, + 'offline_attributes' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_signature_providers' => null, + 'recipient_supplies_tabs' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'require_signer_certificate' => null, + 'require_sign_on_paper' => null, + 'require_upload_signature' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signature_info' => null, + 'signed_date_time' => null, + 'signer_email' => null, + 'signer_email_metadata' => null, + 'signer_first_name' => null, + 'signer_first_name_metadata' => null, + 'signer_last_name' => null, + 'signer_last_name_metadata' => null, + 'signer_name' => null, + 'signer_name_metadata' => null, + 'sign_in_each_location' => null, + 'sign_in_each_location_metadata' => null, + 'signing_group_id' => null, + 'signing_group_id_metadata' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'tabs' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -190,6 +310,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_configuration_name_metadata' => 'idCheckConfigurationNameMetadata', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'in_person_signing_type' => 'inPersonSigningType', 'in_person_signing_type_metadata' => 'inPersonSigningTypeMetadata', @@ -248,9 +369,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -288,6 +409,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'setIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'in_person_signing_type' => 'setInPersonSigningType', 'in_person_signing_type_metadata' => 'setInPersonSigningTypeMetadata', @@ -346,9 +468,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -386,6 +508,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'getIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'in_person_signing_type' => 'getInPersonSigningType', 'in_person_signing_type_metadata' => 'getInPersonSigningTypeMetadata', @@ -444,34 +567,63 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -509,6 +661,7 @@ public function __construct(array $data = null) $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_configuration_name_metadata'] = isset($data['id_check_configuration_name_metadata']) ? $data['id_check_configuration_name_metadata'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['identity_verification'] = isset($data['identity_verification']) ? $data['identity_verification'] : 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['in_person_signing_type_metadata'] = isset($data['in_person_signing_type_metadata']) ? $data['in_person_signing_type_metadata'] : null; @@ -568,30 +721,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -601,7 +756,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -613,6 +770,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -622,7 +780,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -634,6 +794,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -643,7 +804,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -655,6 +818,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -664,7 +828,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -676,6 +842,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -685,7 +852,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -697,6 +866,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets can_sign_offline + * * @return string */ public function getCanSignOffline() @@ -706,7 +876,9 @@ public function getCanSignOffline() /** * 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) @@ -718,6 +890,7 @@ public function setCanSignOffline($can_sign_offline) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -727,7 +900,9 @@ public function getClientUserId() /** * 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) @@ -739,6 +914,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -748,7 +924,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -760,6 +938,7 @@ public function setCompletedCount($completed_count) /** * Gets creation_reason + * * @return string */ public function getCreationReason() @@ -769,7 +948,9 @@ public function getCreationReason() /** * Sets creation_reason + * * @param string $creation_reason + * * @return $this */ public function setCreationReason($creation_reason) @@ -781,6 +962,7 @@ public function setCreationReason($creation_reason) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -790,7 +972,9 @@ public function getCustomFields() /** * 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) @@ -802,6 +986,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -811,7 +996,9 @@ public function getDeclinedDateTime() /** * 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) @@ -823,6 +1010,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -832,7 +1020,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -844,6 +1034,7 @@ public function setDeclinedReason($declined_reason) /** * Gets default_recipient + * * @return string */ public function getDefaultRecipient() @@ -853,7 +1044,9 @@ public function getDefaultRecipient() /** * Sets default_recipient + * * @param string $default_recipient + * * @return $this */ public function setDefaultRecipient($default_recipient) @@ -865,6 +1058,7 @@ public function setDefaultRecipient($default_recipient) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -874,7 +1068,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -886,6 +1082,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -895,7 +1092,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -907,6 +1106,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -916,7 +1116,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -928,6 +1130,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -937,7 +1140,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -949,6 +1154,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -958,7 +1164,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -970,6 +1178,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -979,7 +1188,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -991,6 +1202,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -1000,7 +1212,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -1012,6 +1226,7 @@ public function setEmail($email) /** * Gets email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailMetadata() @@ -1021,7 +1236,9 @@ public function getEmailMetadata() /** * Sets email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata email_metadata + * * @return $this */ public function setEmailMetadata($email_metadata) @@ -1033,6 +1250,7 @@ public function setEmailMetadata($email_metadata) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -1042,7 +1260,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -1054,6 +1274,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -1063,7 +1284,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -1075,6 +1298,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1084,7 +1308,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1096,6 +1322,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -1105,7 +1332,9 @@ public function getExcludedDocuments() /** * 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) @@ -1117,6 +1346,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -1126,7 +1356,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -1138,6 +1370,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -1147,7 +1380,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -1159,6 +1394,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets host_email + * * @return string */ public function getHostEmail() @@ -1168,7 +1404,9 @@ public function getHostEmail() /** * Sets host_email + * * @param string $host_email + * * @return $this */ public function setHostEmail($host_email) @@ -1180,6 +1418,7 @@ public function setHostEmail($host_email) /** * Gets host_email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHostEmailMetadata() @@ -1189,7 +1428,9 @@ public function getHostEmailMetadata() /** * Sets host_email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $host_email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $host_email_metadata host_email_metadata + * * @return $this */ public function setHostEmailMetadata($host_email_metadata) @@ -1201,6 +1442,7 @@ public function setHostEmailMetadata($host_email_metadata) /** * Gets host_name + * * @return string */ public function getHostName() @@ -1210,7 +1452,9 @@ public function getHostName() /** * Sets host_name + * * @param string $host_name Specifies the name of the signing host. It is a required element for In Person Signers recipient Type. Maximum Length: 100 characters. + * * @return $this */ public function setHostName($host_name) @@ -1222,6 +1466,7 @@ public function setHostName($host_name) /** * Gets host_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHostNameMetadata() @@ -1231,7 +1476,9 @@ public function getHostNameMetadata() /** * Sets host_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $host_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $host_name_metadata host_name_metadata + * * @return $this */ public function setHostNameMetadata($host_name_metadata) @@ -1243,6 +1490,7 @@ public function setHostNameMetadata($host_name_metadata) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -1252,7 +1500,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -1264,6 +1514,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -1273,7 +1524,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -1285,6 +1538,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1294,7 +1548,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -1304,8 +1560,33 @@ public function setIdCheckInformationInput($id_check_information_input) return $this; } + /** + * Gets identity_verification + * + * @return \DocuSign\eSign\Model\RecipientIdentityVerification + */ + public function getIdentityVerification() + { + return $this->container['identity_verification']; + } + + /** + * Sets identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * + * @return $this + */ + public function setIdentityVerification($identity_verification) + { + $this->container['identity_verification'] = $identity_verification; + + return $this; + } + /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1315,7 +1596,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -1327,6 +1610,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets in_person_signing_type + * * @return string */ public function getInPersonSigningType() @@ -1336,7 +1620,9 @@ public function getInPersonSigningType() /** * Sets in_person_signing_type + * * @param string $in_person_signing_type + * * @return $this */ public function setInPersonSigningType($in_person_signing_type) @@ -1348,6 +1634,7 @@ public function setInPersonSigningType($in_person_signing_type) /** * Gets in_person_signing_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getInPersonSigningTypeMetadata() @@ -1357,7 +1644,9 @@ public function getInPersonSigningTypeMetadata() /** * Sets in_person_signing_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $in_person_signing_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $in_person_signing_type_metadata in_person_signing_type_metadata + * * @return $this */ public function setInPersonSigningTypeMetadata($in_person_signing_type_metadata) @@ -1369,6 +1658,7 @@ public function setInPersonSigningTypeMetadata($in_person_signing_type_metadata) /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -1378,7 +1668,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -1390,6 +1682,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -1399,7 +1692,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -1411,6 +1706,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -1420,7 +1716,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1432,6 +1730,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1441,7 +1740,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1453,6 +1754,7 @@ public function setNameMetadata($name_metadata) /** * Gets notary_host + * * @return \DocuSign\eSign\Model\NotaryHost */ public function getNotaryHost() @@ -1462,7 +1764,9 @@ public function getNotaryHost() /** * Sets notary_host - * @param \DocuSign\eSign\Model\NotaryHost $notary_host + * + * @param \DocuSign\eSign\Model\NotaryHost $notary_host notary_host + * * @return $this */ public function setNotaryHost($notary_host) @@ -1474,6 +1778,7 @@ public function setNotaryHost($notary_host) /** * Gets note + * * @return string */ public function getNote() @@ -1483,7 +1788,9 @@ public function getNote() /** * 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) @@ -1495,6 +1802,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1504,7 +1812,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1516,6 +1826,7 @@ public function setNoteMetadata($note_metadata) /** * Gets offline_attributes + * * @return \DocuSign\eSign\Model\OfflineAttributes */ public function getOfflineAttributes() @@ -1525,7 +1836,9 @@ public function getOfflineAttributes() /** * Sets offline_attributes - * @param \DocuSign\eSign\Model\OfflineAttributes $offline_attributes + * + * @param \DocuSign\eSign\Model\OfflineAttributes $offline_attributes offline_attributes + * * @return $this */ public function setOfflineAttributes($offline_attributes) @@ -1537,6 +1850,7 @@ public function setOfflineAttributes($offline_attributes) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1546,7 +1860,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1558,6 +1874,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1567,7 +1884,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1579,6 +1898,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1588,7 +1908,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1600,6 +1922,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1609,7 +1932,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1621,6 +1946,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1630,7 +1956,9 @@ public function getRecipientId() /** * 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) @@ -1642,6 +1970,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1651,7 +1980,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1663,6 +1994,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -1672,7 +2004,9 @@ public function getRecipientSignatureProviders() /** * Sets recipient_signature_providers + * * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * * @return $this */ public function setRecipientSignatureProviders($recipient_signature_providers) @@ -1684,6 +2018,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets recipient_supplies_tabs + * * @return string */ public function getRecipientSuppliesTabs() @@ -1693,7 +2028,9 @@ public function getRecipientSuppliesTabs() /** * Sets recipient_supplies_tabs + * * @param string $recipient_supplies_tabs + * * @return $this */ public function setRecipientSuppliesTabs($recipient_supplies_tabs) @@ -1705,6 +2042,7 @@ public function setRecipientSuppliesTabs($recipient_supplies_tabs) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1714,7 +2052,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1726,6 +2066,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1735,7 +2076,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1747,6 +2090,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1756,7 +2100,9 @@ public function getRequireIdLookup() /** * 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) @@ -1768,6 +2114,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1777,7 +2124,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1789,6 +2138,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets require_signer_certificate + * * @return string */ public function getRequireSignerCertificate() @@ -1798,7 +2148,9 @@ public function getRequireSignerCertificate() /** * Sets require_signer_certificate + * * @param string $require_signer_certificate + * * @return $this */ public function setRequireSignerCertificate($require_signer_certificate) @@ -1810,6 +2162,7 @@ public function setRequireSignerCertificate($require_signer_certificate) /** * Gets require_sign_on_paper + * * @return string */ public function getRequireSignOnPaper() @@ -1819,7 +2172,9 @@ public function getRequireSignOnPaper() /** * Sets require_sign_on_paper + * * @param string $require_sign_on_paper + * * @return $this */ public function setRequireSignOnPaper($require_sign_on_paper) @@ -1831,6 +2186,7 @@ public function setRequireSignOnPaper($require_sign_on_paper) /** * Gets require_upload_signature + * * @return string */ public function getRequireUploadSignature() @@ -1840,7 +2196,9 @@ public function getRequireUploadSignature() /** * Sets require_upload_signature + * * @param string $require_upload_signature + * * @return $this */ public function setRequireUploadSignature($require_upload_signature) @@ -1852,6 +2210,7 @@ public function setRequireUploadSignature($require_upload_signature) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1861,7 +2220,9 @@ public function getRoleName() /** * 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) @@ -1873,6 +2234,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1882,7 +2244,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -1894,6 +2258,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -1903,7 +2268,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -1915,6 +2282,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1924,7 +2292,9 @@ public function getSentDateTime() /** * 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) @@ -1936,6 +2306,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signature_info + * * @return \DocuSign\eSign\Model\RecipientSignatureInformation */ public function getSignatureInfo() @@ -1945,7 +2316,9 @@ public function getSignatureInfo() /** * Sets signature_info - * @param \DocuSign\eSign\Model\RecipientSignatureInformation $signature_info + * + * @param \DocuSign\eSign\Model\RecipientSignatureInformation $signature_info signature_info + * * @return $this */ public function setSignatureInfo($signature_info) @@ -1957,6 +2330,7 @@ public function setSignatureInfo($signature_info) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1966,7 +2340,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -1978,6 +2354,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signer_email + * * @return string */ public function getSignerEmail() @@ -1987,7 +2364,9 @@ public function getSignerEmail() /** * Sets signer_email + * * @param string $signer_email The email address for an InPersonSigner recipient Type. Maximum Length: 100 characters. + * * @return $this */ public function setSignerEmail($signer_email) @@ -1999,6 +2378,7 @@ public function setSignerEmail($signer_email) /** * Gets signer_email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignerEmailMetadata() @@ -2008,7 +2388,9 @@ public function getSignerEmailMetadata() /** * Sets signer_email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signer_email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signer_email_metadata signer_email_metadata + * * @return $this */ public function setSignerEmailMetadata($signer_email_metadata) @@ -2020,6 +2402,7 @@ public function setSignerEmailMetadata($signer_email_metadata) /** * Gets signer_first_name + * * @return string */ public function getSignerFirstName() @@ -2029,7 +2412,9 @@ public function getSignerFirstName() /** * Sets signer_first_name + * * @param string $signer_first_name + * * @return $this */ public function setSignerFirstName($signer_first_name) @@ -2041,6 +2426,7 @@ public function setSignerFirstName($signer_first_name) /** * Gets signer_first_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignerFirstNameMetadata() @@ -2050,7 +2436,9 @@ public function getSignerFirstNameMetadata() /** * Sets signer_first_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signer_first_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signer_first_name_metadata signer_first_name_metadata + * * @return $this */ public function setSignerFirstNameMetadata($signer_first_name_metadata) @@ -2062,6 +2450,7 @@ public function setSignerFirstNameMetadata($signer_first_name_metadata) /** * Gets signer_last_name + * * @return string */ public function getSignerLastName() @@ -2071,7 +2460,9 @@ public function getSignerLastName() /** * Sets signer_last_name + * * @param string $signer_last_name + * * @return $this */ public function setSignerLastName($signer_last_name) @@ -2083,6 +2474,7 @@ public function setSignerLastName($signer_last_name) /** * Gets signer_last_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignerLastNameMetadata() @@ -2092,7 +2484,9 @@ public function getSignerLastNameMetadata() /** * Sets signer_last_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signer_last_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signer_last_name_metadata signer_last_name_metadata + * * @return $this */ public function setSignerLastNameMetadata($signer_last_name_metadata) @@ -2104,6 +2498,7 @@ public function setSignerLastNameMetadata($signer_last_name_metadata) /** * Gets signer_name + * * @return string */ public function getSignerName() @@ -2113,7 +2508,9 @@ public function getSignerName() /** * Sets signer_name + * * @param string $signer_name Required. The full legal name of a signer for the envelope. Maximum Length: 100 characters. + * * @return $this */ public function setSignerName($signer_name) @@ -2125,6 +2522,7 @@ public function setSignerName($signer_name) /** * Gets signer_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignerNameMetadata() @@ -2134,7 +2532,9 @@ public function getSignerNameMetadata() /** * Sets signer_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signer_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signer_name_metadata signer_name_metadata + * * @return $this */ public function setSignerNameMetadata($signer_name_metadata) @@ -2146,6 +2546,7 @@ public function setSignerNameMetadata($signer_name_metadata) /** * Gets sign_in_each_location + * * @return string */ public function getSignInEachLocation() @@ -2155,7 +2556,9 @@ public function getSignInEachLocation() /** * 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) @@ -2167,6 +2570,7 @@ public function setSignInEachLocation($sign_in_each_location) /** * Gets sign_in_each_location_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignInEachLocationMetadata() @@ -2176,7 +2580,9 @@ public function getSignInEachLocationMetadata() /** * Sets sign_in_each_location_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sign_in_each_location_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sign_in_each_location_metadata sign_in_each_location_metadata + * * @return $this */ public function setSignInEachLocationMetadata($sign_in_each_location_metadata) @@ -2188,6 +2594,7 @@ public function setSignInEachLocationMetadata($sign_in_each_location_metadata) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -2197,7 +2604,9 @@ public function getSigningGroupId() /** * 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) @@ -2209,6 +2618,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSigningGroupIdMetadata() @@ -2218,7 +2628,9 @@ public function getSigningGroupIdMetadata() /** * Sets signing_group_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata signing_group_id_metadata + * * @return $this */ public function setSigningGroupIdMetadata($signing_group_id_metadata) @@ -2230,6 +2642,7 @@ public function setSigningGroupIdMetadata($signing_group_id_metadata) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -2239,7 +2652,9 @@ public function getSigningGroupName() /** * 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) @@ -2251,6 +2666,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -2260,7 +2676,9 @@ public function getSigningGroupUsers() /** * 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) @@ -2272,6 +2690,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -2281,7 +2700,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -2293,6 +2714,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -2302,7 +2724,9 @@ public function getSocialAuthentications() /** * 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) @@ -2314,6 +2738,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -2323,7 +2748,9 @@ public function getStatus() /** * 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) @@ -2335,6 +2762,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -2344,7 +2772,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -2356,6 +2786,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -2365,7 +2796,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -2377,6 +2810,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -2386,7 +2820,9 @@ public function getTabs() /** * Sets tabs - * @param \DocuSign\eSign\Model\Tabs $tabs + * + * @param \DocuSign\eSign\Model\Tabs $tabs tabs + * * @return $this */ public function setTabs($tabs) @@ -2398,6 +2834,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2407,7 +2844,9 @@ public function getTemplateLocked() /** * 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) @@ -2419,6 +2858,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2428,7 +2868,9 @@ public function getTemplateRequired() /** * 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) @@ -2440,6 +2882,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -2449,7 +2892,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -2461,6 +2906,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -2470,7 +2916,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -2481,7 +2929,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2491,7 +2941,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2501,8 +2953,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2516,7 +2970,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2526,16 +2982,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/InitialHere.php b/src/Model/InitialHere.php index 824d2dbc..faf88264 100644 --- a/src/Model/InitialHere.php +++ b/src/Model/InitialHere.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * InitialHere Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class InitialHere implements ArrayAccess +class InitialHere implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'initialHere'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -132,13 +135,114 @@ class InitialHere implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'optional' => null, + 'optional_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'scale_value' => null, + 'scale_value_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -220,9 +324,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -304,9 +408,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -388,34 +492,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -498,30 +631,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -531,7 +666,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -543,6 +680,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -552,7 +690,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -564,6 +704,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -573,7 +714,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -585,6 +728,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -594,7 +738,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -606,6 +752,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -615,7 +762,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -627,6 +776,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -636,7 +786,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -648,6 +800,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -657,7 +810,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -669,6 +824,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -678,7 +834,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -690,6 +848,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -699,7 +858,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -711,6 +872,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -720,7 +882,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -732,6 +896,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -741,7 +906,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -753,6 +920,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -762,7 +930,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -774,6 +944,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -783,7 +954,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -795,6 +968,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -804,7 +978,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -816,6 +992,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -825,7 +1002,9 @@ public function getAnchorUnits() /** * 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) @@ -837,6 +1016,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -846,7 +1026,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -858,6 +1040,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -867,7 +1050,9 @@ public function getAnchorXOffset() /** * 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) @@ -879,6 +1064,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -888,7 +1074,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -900,6 +1088,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -909,7 +1098,9 @@ public function getAnchorYOffset() /** * 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) @@ -921,6 +1112,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -930,7 +1122,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -942,6 +1136,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -951,7 +1146,9 @@ public function getConditionalParentLabel() /** * 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) @@ -963,6 +1160,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -972,7 +1170,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -984,6 +1184,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -993,7 +1194,9 @@ public function getConditionalParentValue() /** * 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) @@ -1005,6 +1208,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1014,7 +1218,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1026,6 +1232,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1035,7 +1242,9 @@ public function getCustomTabId() /** * 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) @@ -1047,6 +1256,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1056,7 +1266,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1068,6 +1280,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1077,7 +1290,9 @@ public function getDocumentId() /** * 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) @@ -1089,6 +1304,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1098,7 +1314,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1110,6 +1328,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1119,7 +1338,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1131,6 +1352,7 @@ public function setErrorDetails($error_details) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1140,7 +1362,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1152,6 +1376,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1161,7 +1386,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1173,6 +1400,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1182,7 +1410,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1194,6 +1424,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1203,7 +1434,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1215,6 +1448,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1224,7 +1458,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1236,6 +1472,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1245,7 +1482,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1257,6 +1496,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1266,7 +1506,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1278,6 +1520,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1287,7 +1530,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1299,6 +1544,7 @@ public function setHeightMetadata($height_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1308,7 +1554,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1320,6 +1568,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1329,7 +1578,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1341,6 +1592,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1350,7 +1602,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -1362,6 +1616,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1371,7 +1626,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1383,6 +1640,7 @@ public function setNameMetadata($name_metadata) /** * Gets optional + * * @return string */ public function getOptional() @@ -1392,7 +1650,9 @@ public function getOptional() /** * Sets optional + * * @param string $optional + * * @return $this */ public function setOptional($optional) @@ -1404,6 +1664,7 @@ public function setOptional($optional) /** * Gets optional_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOptionalMetadata() @@ -1413,7 +1674,9 @@ public function getOptionalMetadata() /** * Sets optional_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $optional_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $optional_metadata optional_metadata + * * @return $this */ public function setOptionalMetadata($optional_metadata) @@ -1425,6 +1688,7 @@ public function setOptionalMetadata($optional_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1434,7 +1698,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1446,6 +1712,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1455,7 +1722,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1467,6 +1736,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1476,7 +1746,9 @@ public function getRecipientId() /** * 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) @@ -1488,6 +1760,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1497,7 +1770,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1509,6 +1784,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1518,7 +1794,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1530,6 +1808,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1539,7 +1818,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1551,6 +1832,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets scale_value + * * @return string */ public function getScaleValue() @@ -1560,7 +1842,9 @@ public function getScaleValue() /** * Sets scale_value + * * @param string $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) @@ -1572,6 +1856,7 @@ public function setScaleValue($scale_value) /** * Gets scale_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getScaleValueMetadata() @@ -1581,7 +1866,9 @@ public function getScaleValueMetadata() /** * Sets scale_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $scale_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $scale_value_metadata scale_value_metadata + * * @return $this */ public function setScaleValueMetadata($scale_value_metadata) @@ -1593,6 +1880,7 @@ public function setScaleValueMetadata($scale_value_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1602,7 +1890,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1614,6 +1904,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1623,7 +1914,9 @@ public function getStatus() /** * 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) @@ -1635,6 +1928,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1644,7 +1938,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1656,6 +1952,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1665,7 +1962,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1677,6 +1976,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1686,7 +1986,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1698,6 +2000,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1707,7 +2010,9 @@ public function getTabId() /** * 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) @@ -1719,6 +2024,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1728,7 +2034,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1740,6 +2048,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1749,7 +2058,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1761,6 +2072,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1770,7 +2082,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1782,6 +2096,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1791,7 +2106,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1803,6 +2120,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1812,7 +2130,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -1824,6 +2144,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -1833,7 +2154,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -1845,6 +2168,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -1854,7 +2178,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -1866,6 +2192,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1875,7 +2202,9 @@ public function getTemplateLocked() /** * 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) @@ -1887,6 +2216,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -1896,7 +2226,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -1908,6 +2240,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1917,7 +2250,9 @@ public function getTemplateRequired() /** * 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) @@ -1929,6 +2264,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -1938,7 +2274,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -1950,6 +2288,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1959,7 +2298,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1971,6 +2312,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -1980,7 +2322,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -1992,6 +2336,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2001,7 +2346,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2013,6 +2360,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2022,7 +2370,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2034,6 +2384,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2043,7 +2394,9 @@ public function getXPosition() /** * 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) @@ -2055,6 +2408,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2064,7 +2418,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2076,6 +2432,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2085,7 +2442,9 @@ public function getYPosition() /** * 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) @@ -2097,6 +2456,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2106,7 +2466,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2117,7 +2479,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2127,7 +2491,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2137,8 +2503,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2152,7 +2520,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2162,16 +2532,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/InlineTemplate.php b/src/Model/InlineTemplate.php index 24771fdf..c76ea3ec 100644 --- a/src/Model/InlineTemplate.php +++ b/src/Model/InlineTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * InlineTemplate Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class InlineTemplate implements ArrayAccess +class InlineTemplate implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'inlineTemplate'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class InlineTemplate implements ArrayAccess 'sequence' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'custom_fields' => null, + 'documents' => null, + 'envelope' => null, + 'recipients' => null, + 'sequence' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'sequence' => 'sequence' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'sequence' => 'setSequence' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'sequence' => 'getSequence' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\CustomFields */ public function getCustomFields() @@ -176,7 +240,9 @@ public function getCustomFields() /** * Sets custom_fields - * @param \DocuSign\eSign\Model\CustomFields $custom_fields + * + * @param \DocuSign\eSign\Model\CustomFields $custom_fields custom_fields + * * @return $this */ public function setCustomFields($custom_fields) @@ -188,6 +254,7 @@ public function setCustomFields($custom_fields) /** * Gets documents + * * @return \DocuSign\eSign\Model\Document[] */ public function getDocuments() @@ -197,7 +264,9 @@ public function getDocuments() /** * Sets documents + * * @param \DocuSign\eSign\Model\Document[] $documents Complex element contains the details on the documents in the envelope. + * * @return $this */ public function setDocuments($documents) @@ -209,6 +278,7 @@ public function setDocuments($documents) /** * Gets envelope + * * @return \DocuSign\eSign\Model\Envelope */ public function getEnvelope() @@ -218,7 +288,9 @@ public function getEnvelope() /** * Sets envelope - * @param \DocuSign\eSign\Model\Envelope $envelope + * + * @param \DocuSign\eSign\Model\Envelope $envelope envelope + * * @return $this */ public function setEnvelope($envelope) @@ -230,6 +302,7 @@ public function setEnvelope($envelope) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -239,7 +312,9 @@ public function getRecipients() /** * Sets recipients - * @param \DocuSign\eSign\Model\Recipients $recipients + * + * @param \DocuSign\eSign\Model\Recipients $recipients recipients + * * @return $this */ public function setRecipients($recipients) @@ -251,6 +326,7 @@ public function setRecipients($recipients) /** * Gets sequence + * * @return string */ public function getSequence() @@ -260,7 +336,9 @@ public function getSequence() /** * Sets sequence + * * @param string $sequence Specifies the order in which templates are overlaid. + * * @return $this */ public function setSequence($sequence) @@ -271,7 +349,9 @@ public function setSequence($sequence) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/IntegratedUserInfoList.php b/src/Model/IntegratedUserInfoList.php index 57ade988..ff031d84 100644 --- a/src/Model/IntegratedUserInfoList.php +++ b/src/Model/IntegratedUserInfoList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * IntegratedUserInfoList Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class IntegratedUserInfoList implements ArrayAccess +class IntegratedUserInfoList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'integratedUserInfoList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class IntegratedUserInfoList implements ArrayAccess 'users' => '\DocuSign\eSign\Model\UserInfo[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'all_users_selected' => null, + 'end_position' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null, + 'users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'users' => 'users' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'users' => 'setUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'users' => 'getUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets all_users_selected + * * @return string */ public function getAllUsersSelected() @@ -191,7 +258,9 @@ public function getAllUsersSelected() /** * Sets all_users_selected + * * @param string $all_users_selected + * * @return $this */ public function setAllUsersSelected($all_users_selected) @@ -203,6 +272,7 @@ public function setAllUsersSelected($all_users_selected) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -212,7 +282,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -224,6 +296,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -233,7 +306,9 @@ public function getNextUri() /** * 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) @@ -245,6 +320,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -254,7 +330,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -266,6 +344,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -275,7 +354,9 @@ public function getResultSetSize() /** * 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) @@ -287,6 +368,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -296,7 +378,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -308,6 +392,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -317,7 +402,9 @@ public function getTotalSetSize() /** * 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) @@ -329,6 +416,7 @@ public function setTotalSetSize($total_set_size) /** * Gets users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getUsers() @@ -338,7 +426,9 @@ public function getUsers() /** * Sets users + * * @param \DocuSign\eSign\Model\UserInfo[] $users + * * @return $this */ public function setUsers($users) @@ -349,7 +439,9 @@ public function setUsers($users) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Intermediary.php b/src/Model/Intermediary.php index 12ef12d8..5486624d 100644 --- a/src/Model/Intermediary.php +++ b/src/Model/Intermediary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Intermediary Class Doc Comment @@ -39,24 +40,28 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Intermediary implements ArrayAccess +class Intermediary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'intermediary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'access_code' => 'string', 'access_code_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'add_access_code_to_email' => 'string', + 'additional_notifications' => '\DocuSign\eSign\Model\RecipientAdditionalNotification[]', + 'additional_notifications_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'allow_system_override_for_locked_recipient' => 'string', 'client_user_id' => 'string', 'completed_count' => 'string', @@ -84,6 +89,7 @@ class Intermediary implements ArrayAccess 'id_check_configuration_name' => 'string', 'id_check_configuration_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'last_name' => 'string', 'last_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', @@ -123,19 +129,116 @@ class Intermediary implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'additional_notifications' => null, + 'additional_notifications_metadata' => null, + 'allow_system_override_for_locked_recipient' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email' => null, + 'email_metadata' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'first_name' => null, + 'first_name_metadata' => null, + 'full_name' => null, + 'full_name_metadata' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'last_name_metadata' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'name_metadata' => null, + 'note' => null, + 'note_metadata' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_id_metadata' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'access_code' => 'accessCode', 'access_code_metadata' => 'accessCodeMetadata', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'additional_notifications' => 'additionalNotifications', + 'additional_notifications_metadata' => 'additionalNotificationsMetadata', 'allow_system_override_for_locked_recipient' => 'allowSystemOverrideForLockedRecipient', 'client_user_id' => 'clientUserId', 'completed_count' => 'completedCount', @@ -163,6 +266,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_configuration_name_metadata' => 'idCheckConfigurationNameMetadata', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'last_name' => 'lastName', 'last_name_metadata' => 'lastNameMetadata', @@ -202,15 +306,17 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'access_code' => 'setAccessCode', 'access_code_metadata' => 'setAccessCodeMetadata', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'additional_notifications' => 'setAdditionalNotifications', + 'additional_notifications_metadata' => 'setAdditionalNotificationsMetadata', 'allow_system_override_for_locked_recipient' => 'setAllowSystemOverrideForLockedRecipient', 'client_user_id' => 'setClientUserId', 'completed_count' => 'setCompletedCount', @@ -238,6 +344,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'setIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'last_name' => 'setLastName', 'last_name_metadata' => 'setLastNameMetadata', @@ -277,15 +384,17 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'access_code' => 'getAccessCode', 'access_code_metadata' => 'getAccessCodeMetadata', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'additional_notifications' => 'getAdditionalNotifications', + 'additional_notifications_metadata' => 'getAdditionalNotificationsMetadata', 'allow_system_override_for_locked_recipient' => 'getAllowSystemOverrideForLockedRecipient', 'client_user_id' => 'getClientUserId', 'completed_count' => 'getCompletedCount', @@ -313,6 +422,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'getIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'last_name' => 'getLastName', 'last_name_metadata' => 'getLastNameMetadata', @@ -352,40 +462,71 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @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['access_code_metadata'] = isset($data['access_code_metadata']) ? $data['access_code_metadata'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['additional_notifications'] = isset($data['additional_notifications']) ? $data['additional_notifications'] : null; + $this->container['additional_notifications_metadata'] = isset($data['additional_notifications_metadata']) ? $data['additional_notifications_metadata'] : null; $this->container['allow_system_override_for_locked_recipient'] = isset($data['allow_system_override_for_locked_recipient']) ? $data['allow_system_override_for_locked_recipient'] : null; $this->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; $this->container['completed_count'] = isset($data['completed_count']) ? $data['completed_count'] : null; @@ -413,6 +554,7 @@ public function __construct(array $data = null) $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_configuration_name_metadata'] = isset($data['id_check_configuration_name_metadata']) ? $data['id_check_configuration_name_metadata'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['identity_verification'] = isset($data['identity_verification']) ? $data['identity_verification'] : 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['last_name_metadata'] = isset($data['last_name_metadata']) ? $data['last_name_metadata'] : null; @@ -453,30 +595,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -486,7 +630,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -498,6 +644,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -507,7 +654,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -519,6 +668,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -528,7 +678,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -538,8 +690,57 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets additional_notifications + * + * @return \DocuSign\eSign\Model\RecipientAdditionalNotification[] + */ + public function getAdditionalNotifications() + { + return $this->container['additional_notifications']; + } + + /** + * Sets additional_notifications + * + * @param \DocuSign\eSign\Model\RecipientAdditionalNotification[] $additional_notifications + * + * @return $this + */ + public function setAdditionalNotifications($additional_notifications) + { + $this->container['additional_notifications'] = $additional_notifications; + + return $this; + } + + /** + * Gets additional_notifications_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getAdditionalNotificationsMetadata() + { + return $this->container['additional_notifications_metadata']; + } + + /** + * Sets additional_notifications_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $additional_notifications_metadata additional_notifications_metadata + * + * @return $this + */ + public function setAdditionalNotificationsMetadata($additional_notifications_metadata) + { + $this->container['additional_notifications_metadata'] = $additional_notifications_metadata; + + return $this; + } + /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -549,7 +750,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -561,6 +764,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -570,7 +774,9 @@ public function getClientUserId() /** * 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) @@ -582,6 +788,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -591,7 +798,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -603,6 +812,7 @@ public function setCompletedCount($completed_count) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -612,7 +822,9 @@ public function getCustomFields() /** * 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) @@ -624,6 +836,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -633,7 +846,9 @@ public function getDeclinedDateTime() /** * 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) @@ -645,6 +860,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -654,7 +870,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -666,6 +884,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -675,7 +894,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -687,6 +908,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -696,7 +918,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -708,6 +932,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -717,7 +942,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -729,6 +956,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -738,7 +966,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -750,6 +980,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -759,7 +990,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -771,6 +1004,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -780,7 +1014,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -792,6 +1028,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -801,7 +1038,9 @@ public function getEmail() /** * Sets email + * * @param string $email Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. + * * @return $this */ public function setEmail($email) @@ -813,6 +1052,7 @@ public function setEmail($email) /** * Gets email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailMetadata() @@ -822,7 +1062,9 @@ public function getEmailMetadata() /** * Sets email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata email_metadata + * * @return $this */ public function setEmailMetadata($email_metadata) @@ -834,6 +1076,7 @@ public function setEmailMetadata($email_metadata) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -843,7 +1086,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -855,6 +1100,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -864,7 +1110,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -876,6 +1124,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -885,7 +1134,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -897,6 +1148,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -906,7 +1158,9 @@ public function getExcludedDocuments() /** * 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) @@ -918,6 +1172,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -927,7 +1182,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -939,6 +1196,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -948,7 +1206,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -960,6 +1220,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -969,7 +1230,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -981,6 +1244,7 @@ public function setFirstName($first_name) /** * Gets first_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFirstNameMetadata() @@ -990,7 +1254,9 @@ public function getFirstNameMetadata() /** * Sets first_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata first_name_metadata + * * @return $this */ public function setFirstNameMetadata($first_name_metadata) @@ -1002,6 +1268,7 @@ public function setFirstNameMetadata($first_name_metadata) /** * Gets full_name + * * @return string */ public function getFullName() @@ -1011,7 +1278,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -1023,6 +1292,7 @@ public function setFullName($full_name) /** * Gets full_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFullNameMetadata() @@ -1032,7 +1302,9 @@ public function getFullNameMetadata() /** * Sets full_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata full_name_metadata + * * @return $this */ public function setFullNameMetadata($full_name_metadata) @@ -1044,6 +1316,7 @@ public function setFullNameMetadata($full_name_metadata) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -1053,7 +1326,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -1065,6 +1340,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -1074,7 +1350,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -1086,6 +1364,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1095,7 +1374,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -1105,8 +1386,33 @@ public function setIdCheckInformationInput($id_check_information_input) return $this; } + /** + * Gets identity_verification + * + * @return \DocuSign\eSign\Model\RecipientIdentityVerification + */ + public function getIdentityVerification() + { + return $this->container['identity_verification']; + } + + /** + * Sets identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * + * @return $this + */ + public function setIdentityVerification($identity_verification) + { + $this->container['identity_verification'] = $identity_verification; + + return $this; + } + /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1116,7 +1422,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -1128,6 +1436,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -1137,7 +1446,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -1149,6 +1460,7 @@ public function setLastName($last_name) /** * Gets last_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLastNameMetadata() @@ -1158,7 +1470,9 @@ public function getLastNameMetadata() /** * Sets last_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata last_name_metadata + * * @return $this */ public function setLastNameMetadata($last_name_metadata) @@ -1170,6 +1484,7 @@ public function setLastNameMetadata($last_name_metadata) /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -1179,7 +1494,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -1191,6 +1508,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -1200,7 +1518,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -1212,6 +1532,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -1221,7 +1542,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1233,6 +1556,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1242,7 +1566,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1254,6 +1580,7 @@ public function setNameMetadata($name_metadata) /** * Gets note + * * @return string */ public function getNote() @@ -1263,7 +1590,9 @@ public function getNote() /** * 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) @@ -1275,6 +1604,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1284,7 +1614,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1296,6 +1628,7 @@ public function setNoteMetadata($note_metadata) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1305,7 +1638,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1317,6 +1652,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1326,7 +1662,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1338,6 +1676,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1347,7 +1686,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1359,6 +1700,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1368,7 +1710,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1380,6 +1724,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1389,7 +1734,9 @@ public function getRecipientId() /** * 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) @@ -1401,6 +1748,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1410,7 +1758,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1422,6 +1772,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1431,7 +1782,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1443,6 +1796,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1452,7 +1806,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1464,6 +1820,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1473,7 +1830,9 @@ public function getRequireIdLookup() /** * 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) @@ -1485,6 +1844,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1494,7 +1854,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1506,6 +1868,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1515,7 +1878,9 @@ public function getRoleName() /** * 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) @@ -1527,6 +1892,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1536,7 +1902,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -1548,6 +1916,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -1557,7 +1926,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -1569,6 +1940,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1578,7 +1950,9 @@ public function getSentDateTime() /** * 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) @@ -1590,6 +1964,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1599,7 +1974,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -1611,6 +1988,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1620,7 +1998,9 @@ public function getSigningGroupId() /** * 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) @@ -1632,6 +2012,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSigningGroupIdMetadata() @@ -1641,7 +2022,9 @@ public function getSigningGroupIdMetadata() /** * Sets signing_group_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata signing_group_id_metadata + * * @return $this */ public function setSigningGroupIdMetadata($signing_group_id_metadata) @@ -1653,6 +2036,7 @@ public function setSigningGroupIdMetadata($signing_group_id_metadata) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1662,7 +2046,9 @@ public function getSigningGroupName() /** * 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) @@ -1674,6 +2060,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1683,7 +2070,9 @@ public function getSigningGroupUsers() /** * 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) @@ -1695,6 +2084,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1704,7 +2094,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -1716,6 +2108,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1725,7 +2118,9 @@ public function getSocialAuthentications() /** * 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) @@ -1737,6 +2132,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1746,7 +2142,9 @@ public function getStatus() /** * 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) @@ -1758,6 +2156,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -1767,7 +2166,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -1779,6 +2180,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -1788,7 +2190,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -1800,6 +2204,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1809,7 +2214,9 @@ public function getTemplateLocked() /** * 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) @@ -1821,6 +2228,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1830,7 +2238,9 @@ public function getTemplateRequired() /** * 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) @@ -1842,6 +2252,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1851,7 +2262,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1863,6 +2276,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1872,7 +2286,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1883,7 +2299,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1893,7 +2311,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1903,8 +2323,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1918,7 +2340,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1928,16 +2352,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Jurisdiction.php b/src/Model/Jurisdiction.php index d34dd73e..4bf3b274 100644 --- a/src/Model/Jurisdiction.php +++ b/src/Model/Jurisdiction.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Jurisdiction Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Jurisdiction implements ArrayAccess +class Jurisdiction implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'jurisdiction'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class Jurisdiction implements ArrayAccess 'state_name_in_seal' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_system_created_seal' => null, + 'allow_user_uploaded_seal' => null, + 'commission_id_in_seal' => null, + 'county' => null, + 'county_in_seal' => null, + 'enabled' => null, + 'jurisdiction_id' => null, + 'name' => null, + 'notary_public_in_seal' => null, + 'state_name_in_seal' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'state_name_in_seal' => 'stateNameInSeal' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'state_name_in_seal' => 'setStateNameInSeal' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'state_name_in_seal' => 'getStateNameInSeal' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allow_system_created_seal + * * @return string */ public function getAllowSystemCreatedSeal() @@ -201,7 +270,9 @@ public function getAllowSystemCreatedSeal() /** * Sets allow_system_created_seal + * * @param string $allow_system_created_seal + * * @return $this */ public function setAllowSystemCreatedSeal($allow_system_created_seal) @@ -213,6 +284,7 @@ public function setAllowSystemCreatedSeal($allow_system_created_seal) /** * Gets allow_user_uploaded_seal + * * @return string */ public function getAllowUserUploadedSeal() @@ -222,7 +294,9 @@ public function getAllowUserUploadedSeal() /** * Sets allow_user_uploaded_seal + * * @param string $allow_user_uploaded_seal + * * @return $this */ public function setAllowUserUploadedSeal($allow_user_uploaded_seal) @@ -234,6 +308,7 @@ public function setAllowUserUploadedSeal($allow_user_uploaded_seal) /** * Gets commission_id_in_seal + * * @return string */ public function getCommissionIdInSeal() @@ -243,7 +318,9 @@ public function getCommissionIdInSeal() /** * Sets commission_id_in_seal + * * @param string $commission_id_in_seal + * * @return $this */ public function setCommissionIdInSeal($commission_id_in_seal) @@ -255,6 +332,7 @@ public function setCommissionIdInSeal($commission_id_in_seal) /** * Gets county + * * @return string */ public function getCounty() @@ -264,7 +342,9 @@ public function getCounty() /** * Sets county + * * @param string $county + * * @return $this */ public function setCounty($county) @@ -276,6 +356,7 @@ public function setCounty($county) /** * Gets county_in_seal + * * @return string */ public function getCountyInSeal() @@ -285,7 +366,9 @@ public function getCountyInSeal() /** * Sets county_in_seal + * * @param string $county_in_seal + * * @return $this */ public function setCountyInSeal($county_in_seal) @@ -297,6 +380,7 @@ public function setCountyInSeal($county_in_seal) /** * Gets enabled + * * @return string */ public function getEnabled() @@ -306,7 +390,9 @@ public function getEnabled() /** * Sets enabled + * * @param string $enabled + * * @return $this */ public function setEnabled($enabled) @@ -318,6 +404,7 @@ public function setEnabled($enabled) /** * Gets jurisdiction_id + * * @return string */ public function getJurisdictionId() @@ -327,7 +414,9 @@ public function getJurisdictionId() /** * Sets jurisdiction_id + * * @param string $jurisdiction_id + * * @return $this */ public function setJurisdictionId($jurisdiction_id) @@ -339,6 +428,7 @@ public function setJurisdictionId($jurisdiction_id) /** * Gets name + * * @return string */ public function getName() @@ -348,7 +438,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -360,6 +452,7 @@ public function setName($name) /** * Gets notary_public_in_seal + * * @return string */ public function getNotaryPublicInSeal() @@ -369,7 +462,9 @@ public function getNotaryPublicInSeal() /** * Sets notary_public_in_seal + * * @param string $notary_public_in_seal + * * @return $this */ public function setNotaryPublicInSeal($notary_public_in_seal) @@ -381,6 +476,7 @@ public function setNotaryPublicInSeal($notary_public_in_seal) /** * Gets state_name_in_seal + * * @return string */ public function getStateNameInSeal() @@ -390,7 +486,9 @@ public function getStateNameInSeal() /** * Sets state_name_in_seal + * * @param string $state_name_in_seal + * * @return $this */ public function setStateNameInSeal($state_name_in_seal) @@ -401,7 +499,9 @@ public function setStateNameInSeal($state_name_in_seal) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/LastName.php b/src/Model/LastName.php index 32a68409..25d0e367 100644 --- a/src/Model/LastName.php +++ b/src/Model/LastName.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * LastName Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class LastName implements ArrayAccess +class LastName implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'lastName'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -143,13 +146,125 @@ class LastName implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -242,9 +357,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -337,9 +452,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -432,34 +547,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -553,30 +697,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -586,7 +732,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -598,6 +746,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -607,7 +756,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -619,6 +770,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -628,7 +780,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -640,6 +794,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -649,7 +804,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -661,6 +818,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -670,7 +828,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -682,6 +842,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -691,7 +852,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -703,6 +866,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -712,7 +876,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -724,6 +890,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -733,7 +900,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -745,6 +914,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -754,7 +924,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -766,6 +938,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -775,7 +948,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -787,6 +962,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -796,7 +972,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -808,6 +986,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -817,7 +996,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -829,6 +1010,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -838,7 +1020,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -850,6 +1034,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -859,7 +1044,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -871,6 +1058,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -880,7 +1068,9 @@ public function getAnchorUnits() /** * 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) @@ -892,6 +1082,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -901,7 +1092,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -913,6 +1106,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -922,7 +1116,9 @@ public function getAnchorXOffset() /** * 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) @@ -934,6 +1130,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -943,7 +1140,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -955,6 +1154,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -964,7 +1164,9 @@ public function getAnchorYOffset() /** * 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) @@ -976,6 +1178,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -985,7 +1188,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -997,6 +1202,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1006,7 +1212,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1018,6 +1226,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1027,7 +1236,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1039,6 +1250,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1048,7 +1260,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1060,6 +1274,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1069,7 +1284,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1081,6 +1298,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1090,7 +1308,9 @@ public function getConditionalParentValue() /** * 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) @@ -1102,6 +1322,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1111,7 +1332,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1123,6 +1346,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1132,7 +1356,9 @@ public function getCustomTabId() /** * 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) @@ -1144,6 +1370,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1153,7 +1380,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1165,6 +1394,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1174,7 +1404,9 @@ public function getDocumentId() /** * 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) @@ -1186,6 +1418,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1195,7 +1428,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1207,6 +1442,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1216,7 +1452,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1228,6 +1466,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1237,7 +1476,9 @@ public function getFont() /** * 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) @@ -1249,6 +1490,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1258,7 +1500,9 @@ public function getFontColor() /** * 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) @@ -1270,6 +1514,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1279,7 +1524,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1291,6 +1538,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1300,7 +1548,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1312,6 +1562,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1321,7 +1572,9 @@ public function getFontSize() /** * 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) @@ -1333,6 +1586,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1342,7 +1596,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1354,6 +1610,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1363,7 +1620,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1375,6 +1634,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1384,7 +1644,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1396,6 +1658,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1405,7 +1668,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1417,6 +1682,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1426,7 +1692,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1438,6 +1706,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1447,7 +1716,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1459,6 +1730,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1468,7 +1740,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1480,6 +1754,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1489,7 +1764,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1501,6 +1778,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1510,7 +1788,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1522,6 +1802,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1531,7 +1812,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1543,6 +1826,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1552,7 +1836,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1564,6 +1850,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1573,7 +1860,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1585,6 +1874,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1594,7 +1884,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1606,6 +1898,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1615,7 +1908,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1627,6 +1922,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1636,7 +1932,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1648,6 +1946,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1657,7 +1956,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1669,6 +1970,7 @@ public function setNameMetadata($name_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1678,7 +1980,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1690,6 +1994,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1699,7 +2004,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1711,6 +2018,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1720,7 +2028,9 @@ public function getRecipientId() /** * 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) @@ -1732,6 +2042,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1741,7 +2052,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1753,6 +2066,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1762,7 +2076,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1774,6 +2090,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1783,7 +2100,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1795,6 +2114,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1804,7 +2124,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1816,6 +2138,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1825,7 +2148,9 @@ public function getStatus() /** * 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) @@ -1837,6 +2162,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1846,7 +2172,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1858,6 +2186,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1867,7 +2196,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1879,6 +2210,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1888,7 +2220,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1900,6 +2234,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1909,7 +2244,9 @@ public function getTabId() /** * 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) @@ -1921,6 +2258,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1930,7 +2268,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1942,6 +2282,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1951,7 +2292,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1963,6 +2306,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1972,7 +2316,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1984,6 +2330,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1993,7 +2340,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2005,6 +2354,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2014,7 +2364,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2026,6 +2378,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2035,7 +2388,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2047,6 +2402,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2056,7 +2412,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2068,6 +2426,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2077,7 +2436,9 @@ public function getTemplateLocked() /** * 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) @@ -2089,6 +2450,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2098,7 +2460,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2110,6 +2474,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2119,7 +2484,9 @@ public function getTemplateRequired() /** * 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) @@ -2131,6 +2498,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2140,7 +2508,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2152,6 +2522,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2161,7 +2532,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2173,6 +2546,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2182,7 +2556,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2194,6 +2570,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2203,7 +2580,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2215,6 +2594,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2224,7 +2604,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2236,6 +2618,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2245,7 +2628,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2257,6 +2642,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2266,7 +2652,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2278,6 +2666,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2287,7 +2676,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2299,6 +2690,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2308,7 +2700,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2320,6 +2714,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2329,7 +2724,9 @@ public function getXPosition() /** * 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) @@ -2341,6 +2738,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2350,7 +2748,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2362,6 +2762,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2371,7 +2772,9 @@ public function getYPosition() /** * 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) @@ -2383,6 +2786,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2392,7 +2796,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2403,7 +2809,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2413,7 +2821,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2423,8 +2833,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2438,7 +2850,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2448,16 +2862,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ListCustomField.php b/src/Model/ListCustomField.php index 46f6f815..970f4edf 100644 --- a/src/Model/ListCustomField.php +++ b/src/Model/ListCustomField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ListCustomField Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ListCustomField implements ArrayAccess +class ListCustomField implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'listCustomField'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class ListCustomField implements ArrayAccess 'value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'configuration_type' => null, + 'error_details' => null, + 'field_id' => null, + 'list_items' => null, + 'name' => null, + 'required' => null, + 'show' => null, + 'value' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'value' => 'value' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'value' => 'setValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'value' => 'getValue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets configuration_type + * * @return string */ public function getConfigurationType() @@ -191,7 +258,9 @@ public function getConfigurationType() /** * Sets configuration_type + * * @param string $configuration_type If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. + * * @return $this */ public function setConfigurationType($configuration_type) @@ -203,6 +272,7 @@ public function setConfigurationType($configuration_type) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -212,7 +282,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -224,6 +296,7 @@ public function setErrorDetails($error_details) /** * Gets field_id + * * @return string */ public function getFieldId() @@ -233,7 +306,9 @@ public function getFieldId() /** * Sets field_id + * * @param string $field_id An ID used to specify a custom field. + * * @return $this */ public function setFieldId($field_id) @@ -245,6 +320,7 @@ public function setFieldId($field_id) /** * Gets list_items + * * @return string[] */ public function getListItems() @@ -254,7 +330,9 @@ public function getListItems() /** * Sets list_items + * * @param string[] $list_items + * * @return $this */ public function setListItems($list_items) @@ -266,6 +344,7 @@ public function setListItems($list_items) /** * Gets name + * * @return string */ public function getName() @@ -275,7 +354,9 @@ public function getName() /** * Sets name + * * @param string $name The name of the custom field. + * * @return $this */ public function setName($name) @@ -287,6 +368,7 @@ public function setName($name) /** * Gets required + * * @return string */ public function getRequired() @@ -296,7 +378,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -308,6 +392,7 @@ public function setRequired($required) /** * Gets show + * * @return string */ public function getShow() @@ -317,7 +402,9 @@ public function getShow() /** * Sets show + * * @param string $show A boolean indicating if the value should be displayed. + * * @return $this */ public function setShow($show) @@ -329,6 +416,7 @@ public function setShow($show) /** * Gets value + * * @return string */ public function getValue() @@ -338,7 +426,9 @@ public function getValue() /** * Sets value + * * @param string $value The value of the custom field. Maximum Length: 100 characters. + * * @return $this */ public function setValue($value) @@ -349,7 +439,9 @@ public function setValue($value) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ListItem.php b/src/Model/ListItem.php index 8c1ab75c..e7896381 100644 --- a/src/Model/ListItem.php +++ b/src/Model/ListItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ListItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ListItem implements ArrayAccess +class ListItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'listItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class ListItem implements ArrayAccess 'value_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'selected' => null, + 'selected_metadata' => null, + 'text' => null, + 'text_metadata' => null, + 'value' => null, + 'value_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'value_metadata' => 'valueMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'value_metadata' => 'setValueMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'value_metadata' => 'getValueMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets selected + * * @return string */ public function getSelected() @@ -181,7 +246,9 @@ public function getSelected() /** * Sets selected + * * @param string $selected When set to **true**, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default. + * * @return $this */ public function setSelected($selected) @@ -193,6 +260,7 @@ public function setSelected($selected) /** * Gets selected_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSelectedMetadata() @@ -202,7 +270,9 @@ public function getSelectedMetadata() /** * Sets selected_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $selected_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $selected_metadata selected_metadata + * * @return $this */ public function setSelectedMetadata($selected_metadata) @@ -214,6 +284,7 @@ public function setSelectedMetadata($selected_metadata) /** * Gets text + * * @return string */ public function getText() @@ -223,7 +294,9 @@ public function getText() /** * Sets text + * * @param string $text Specifies the text that is shown in the dropdown list. + * * @return $this */ public function setText($text) @@ -235,6 +308,7 @@ public function setText($text) /** * Gets text_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTextMetadata() @@ -244,7 +318,9 @@ public function getTextMetadata() /** * Sets text_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $text_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $text_metadata text_metadata + * * @return $this */ public function setTextMetadata($text_metadata) @@ -256,6 +332,7 @@ public function setTextMetadata($text_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -265,7 +342,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value that is used when the list item is selected. + * * @return $this */ public function setValue($value) @@ -277,6 +356,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -286,7 +366,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -297,7 +379,9 @@ public function setValueMetadata($value_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/LocalePolicy.php b/src/Model/LocalePolicy.php index 5387e77a..97311148 100644 --- a/src/Model/LocalePolicy.php +++ b/src/Model/LocalePolicy.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * LocalePolicy Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class LocalePolicy implements ArrayAccess +class LocalePolicy implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'localePolicy'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -99,13 +102,81 @@ class LocalePolicy implements ArrayAccess 'time_zone_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address_format' => null, + 'address_format_metadata' => null, + 'allow_region' => null, + 'calendar_type' => null, + 'calendar_type_metadata' => null, + 'culture_name' => null, + 'culture_name_metadata' => null, + 'currency_code' => null, + 'currency_code_metadata' => null, + 'currency_negative_format' => null, + 'currency_negative_format_metadata' => null, + 'currency_positive_format' => null, + 'currency_positive_format_metadata' => null, + 'custom_date_format' => null, + 'custom_sign_date_format' => null, + 'custom_sign_time_format' => null, + 'custom_time_format' => null, + 'date_format' => null, + 'date_format_metadata' => null, + 'effective_address_format' => null, + 'effective_calendar_type' => null, + 'effective_currency_code' => null, + 'effective_currency_negative_format' => null, + 'effective_currency_positive_format' => null, + 'effective_custom_date_format' => null, + 'effective_custom_time_format' => null, + 'effective_date_format' => null, + 'effective_initial_format' => null, + 'effective_name_format' => null, + 'effective_time_format' => null, + 'effective_time_zone' => null, + 'initial_format' => null, + 'initial_format_metadata' => null, + 'name_format' => null, + 'name_format_metadata' => null, + 'sign_date_format' => null, + 'sign_date_format_metadata' => null, + 'sign_time_format' => null, + 'sign_time_format_metadata' => null, + 'time_format' => null, + 'time_format_metadata' => null, + 'time_zone' => null, + 'time_zone_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -154,9 +225,9 @@ public static function swaggerTypes() 'time_zone_metadata' => 'timeZoneMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -205,9 +276,9 @@ public static function swaggerTypes() 'time_zone_metadata' => 'setTimeZoneMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -256,34 +327,63 @@ public static function swaggerTypes() 'time_zone_metadata' => 'getTimeZoneMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -333,30 +433,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address_format + * * @return string */ public function getAddressFormat() @@ -366,7 +468,9 @@ public function getAddressFormat() /** * Sets address_format + * * @param string $address_format + * * @return $this */ public function setAddressFormat($address_format) @@ -378,6 +482,7 @@ public function setAddressFormat($address_format) /** * Gets address_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAddressFormatMetadata() @@ -387,7 +492,9 @@ public function getAddressFormatMetadata() /** * Sets address_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $address_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $address_format_metadata address_format_metadata + * * @return $this */ public function setAddressFormatMetadata($address_format_metadata) @@ -399,6 +506,7 @@ public function setAddressFormatMetadata($address_format_metadata) /** * Gets allow_region + * * @return string */ public function getAllowRegion() @@ -408,7 +516,9 @@ public function getAllowRegion() /** * Sets allow_region + * * @param string $allow_region + * * @return $this */ public function setAllowRegion($allow_region) @@ -420,6 +530,7 @@ public function setAllowRegion($allow_region) /** * Gets calendar_type + * * @return string */ public function getCalendarType() @@ -429,7 +540,9 @@ public function getCalendarType() /** * Sets calendar_type + * * @param string $calendar_type + * * @return $this */ public function setCalendarType($calendar_type) @@ -441,6 +554,7 @@ public function setCalendarType($calendar_type) /** * Gets calendar_type_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCalendarTypeMetadata() @@ -450,7 +564,9 @@ public function getCalendarTypeMetadata() /** * Sets calendar_type_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $calendar_type_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $calendar_type_metadata calendar_type_metadata + * * @return $this */ public function setCalendarTypeMetadata($calendar_type_metadata) @@ -462,6 +578,7 @@ public function setCalendarTypeMetadata($calendar_type_metadata) /** * Gets culture_name + * * @return string */ public function getCultureName() @@ -471,7 +588,9 @@ public function getCultureName() /** * Sets culture_name + * * @param string $culture_name + * * @return $this */ public function setCultureName($culture_name) @@ -483,6 +602,7 @@ public function setCultureName($culture_name) /** * Gets culture_name_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCultureNameMetadata() @@ -492,7 +612,9 @@ public function getCultureNameMetadata() /** * Sets culture_name_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $culture_name_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $culture_name_metadata culture_name_metadata + * * @return $this */ public function setCultureNameMetadata($culture_name_metadata) @@ -504,6 +626,7 @@ public function setCultureNameMetadata($culture_name_metadata) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -513,7 +636,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code + * * @return $this */ public function setCurrencyCode($currency_code) @@ -525,6 +650,7 @@ public function setCurrencyCode($currency_code) /** * Gets currency_code_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCurrencyCodeMetadata() @@ -534,7 +660,9 @@ public function getCurrencyCodeMetadata() /** * Sets currency_code_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $currency_code_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $currency_code_metadata currency_code_metadata + * * @return $this */ public function setCurrencyCodeMetadata($currency_code_metadata) @@ -546,6 +674,7 @@ public function setCurrencyCodeMetadata($currency_code_metadata) /** * Gets currency_negative_format + * * @return string */ public function getCurrencyNegativeFormat() @@ -555,7 +684,9 @@ public function getCurrencyNegativeFormat() /** * Sets currency_negative_format + * * @param string $currency_negative_format + * * @return $this */ public function setCurrencyNegativeFormat($currency_negative_format) @@ -567,6 +698,7 @@ public function setCurrencyNegativeFormat($currency_negative_format) /** * Gets currency_negative_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCurrencyNegativeFormatMetadata() @@ -576,7 +708,9 @@ public function getCurrencyNegativeFormatMetadata() /** * Sets currency_negative_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $currency_negative_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $currency_negative_format_metadata currency_negative_format_metadata + * * @return $this */ public function setCurrencyNegativeFormatMetadata($currency_negative_format_metadata) @@ -588,6 +722,7 @@ public function setCurrencyNegativeFormatMetadata($currency_negative_format_meta /** * Gets currency_positive_format + * * @return string */ public function getCurrencyPositiveFormat() @@ -597,7 +732,9 @@ public function getCurrencyPositiveFormat() /** * Sets currency_positive_format + * * @param string $currency_positive_format + * * @return $this */ public function setCurrencyPositiveFormat($currency_positive_format) @@ -609,6 +746,7 @@ public function setCurrencyPositiveFormat($currency_positive_format) /** * Gets currency_positive_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCurrencyPositiveFormatMetadata() @@ -618,7 +756,9 @@ public function getCurrencyPositiveFormatMetadata() /** * Sets currency_positive_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $currency_positive_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $currency_positive_format_metadata currency_positive_format_metadata + * * @return $this */ public function setCurrencyPositiveFormatMetadata($currency_positive_format_metadata) @@ -630,6 +770,7 @@ public function setCurrencyPositiveFormatMetadata($currency_positive_format_meta /** * Gets custom_date_format + * * @return string */ public function getCustomDateFormat() @@ -639,7 +780,9 @@ public function getCustomDateFormat() /** * Sets custom_date_format + * * @param string $custom_date_format + * * @return $this */ public function setCustomDateFormat($custom_date_format) @@ -651,6 +794,7 @@ public function setCustomDateFormat($custom_date_format) /** * Gets custom_sign_date_format + * * @return string */ public function getCustomSignDateFormat() @@ -660,7 +804,9 @@ public function getCustomSignDateFormat() /** * Sets custom_sign_date_format + * * @param string $custom_sign_date_format + * * @return $this */ public function setCustomSignDateFormat($custom_sign_date_format) @@ -672,6 +818,7 @@ public function setCustomSignDateFormat($custom_sign_date_format) /** * Gets custom_sign_time_format + * * @return string */ public function getCustomSignTimeFormat() @@ -681,7 +828,9 @@ public function getCustomSignTimeFormat() /** * Sets custom_sign_time_format + * * @param string $custom_sign_time_format + * * @return $this */ public function setCustomSignTimeFormat($custom_sign_time_format) @@ -693,6 +842,7 @@ public function setCustomSignTimeFormat($custom_sign_time_format) /** * Gets custom_time_format + * * @return string */ public function getCustomTimeFormat() @@ -702,7 +852,9 @@ public function getCustomTimeFormat() /** * Sets custom_time_format + * * @param string $custom_time_format + * * @return $this */ public function setCustomTimeFormat($custom_time_format) @@ -714,6 +866,7 @@ public function setCustomTimeFormat($custom_time_format) /** * Gets date_format + * * @return string */ public function getDateFormat() @@ -723,7 +876,9 @@ public function getDateFormat() /** * Sets date_format + * * @param string $date_format + * * @return $this */ public function setDateFormat($date_format) @@ -735,6 +890,7 @@ public function setDateFormat($date_format) /** * Gets date_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDateFormatMetadata() @@ -744,7 +900,9 @@ public function getDateFormatMetadata() /** * Sets date_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $date_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $date_format_metadata date_format_metadata + * * @return $this */ public function setDateFormatMetadata($date_format_metadata) @@ -756,6 +914,7 @@ public function setDateFormatMetadata($date_format_metadata) /** * Gets effective_address_format + * * @return string */ public function getEffectiveAddressFormat() @@ -765,7 +924,9 @@ public function getEffectiveAddressFormat() /** * Sets effective_address_format + * * @param string $effective_address_format + * * @return $this */ public function setEffectiveAddressFormat($effective_address_format) @@ -777,6 +938,7 @@ public function setEffectiveAddressFormat($effective_address_format) /** * Gets effective_calendar_type + * * @return string */ public function getEffectiveCalendarType() @@ -786,7 +948,9 @@ public function getEffectiveCalendarType() /** * Sets effective_calendar_type + * * @param string $effective_calendar_type + * * @return $this */ public function setEffectiveCalendarType($effective_calendar_type) @@ -798,6 +962,7 @@ public function setEffectiveCalendarType($effective_calendar_type) /** * Gets effective_currency_code + * * @return string */ public function getEffectiveCurrencyCode() @@ -807,7 +972,9 @@ public function getEffectiveCurrencyCode() /** * Sets effective_currency_code + * * @param string $effective_currency_code + * * @return $this */ public function setEffectiveCurrencyCode($effective_currency_code) @@ -819,6 +986,7 @@ public function setEffectiveCurrencyCode($effective_currency_code) /** * Gets effective_currency_negative_format + * * @return string */ public function getEffectiveCurrencyNegativeFormat() @@ -828,7 +996,9 @@ public function getEffectiveCurrencyNegativeFormat() /** * Sets effective_currency_negative_format + * * @param string $effective_currency_negative_format + * * @return $this */ public function setEffectiveCurrencyNegativeFormat($effective_currency_negative_format) @@ -840,6 +1010,7 @@ public function setEffectiveCurrencyNegativeFormat($effective_currency_negative_ /** * Gets effective_currency_positive_format + * * @return string */ public function getEffectiveCurrencyPositiveFormat() @@ -849,7 +1020,9 @@ public function getEffectiveCurrencyPositiveFormat() /** * Sets effective_currency_positive_format + * * @param string $effective_currency_positive_format + * * @return $this */ public function setEffectiveCurrencyPositiveFormat($effective_currency_positive_format) @@ -861,6 +1034,7 @@ public function setEffectiveCurrencyPositiveFormat($effective_currency_positive_ /** * Gets effective_custom_date_format + * * @return string */ public function getEffectiveCustomDateFormat() @@ -870,7 +1044,9 @@ public function getEffectiveCustomDateFormat() /** * Sets effective_custom_date_format + * * @param string $effective_custom_date_format + * * @return $this */ public function setEffectiveCustomDateFormat($effective_custom_date_format) @@ -882,6 +1058,7 @@ public function setEffectiveCustomDateFormat($effective_custom_date_format) /** * Gets effective_custom_time_format + * * @return string */ public function getEffectiveCustomTimeFormat() @@ -891,7 +1068,9 @@ public function getEffectiveCustomTimeFormat() /** * Sets effective_custom_time_format + * * @param string $effective_custom_time_format + * * @return $this */ public function setEffectiveCustomTimeFormat($effective_custom_time_format) @@ -903,6 +1082,7 @@ public function setEffectiveCustomTimeFormat($effective_custom_time_format) /** * Gets effective_date_format + * * @return string */ public function getEffectiveDateFormat() @@ -912,7 +1092,9 @@ public function getEffectiveDateFormat() /** * Sets effective_date_format + * * @param string $effective_date_format + * * @return $this */ public function setEffectiveDateFormat($effective_date_format) @@ -924,6 +1106,7 @@ public function setEffectiveDateFormat($effective_date_format) /** * Gets effective_initial_format + * * @return string */ public function getEffectiveInitialFormat() @@ -933,7 +1116,9 @@ public function getEffectiveInitialFormat() /** * Sets effective_initial_format + * * @param string $effective_initial_format + * * @return $this */ public function setEffectiveInitialFormat($effective_initial_format) @@ -945,6 +1130,7 @@ public function setEffectiveInitialFormat($effective_initial_format) /** * Gets effective_name_format + * * @return string */ public function getEffectiveNameFormat() @@ -954,7 +1140,9 @@ public function getEffectiveNameFormat() /** * Sets effective_name_format + * * @param string $effective_name_format + * * @return $this */ public function setEffectiveNameFormat($effective_name_format) @@ -966,6 +1154,7 @@ public function setEffectiveNameFormat($effective_name_format) /** * Gets effective_time_format + * * @return string */ public function getEffectiveTimeFormat() @@ -975,7 +1164,9 @@ public function getEffectiveTimeFormat() /** * Sets effective_time_format + * * @param string $effective_time_format + * * @return $this */ public function setEffectiveTimeFormat($effective_time_format) @@ -987,6 +1178,7 @@ public function setEffectiveTimeFormat($effective_time_format) /** * Gets effective_time_zone + * * @return string */ public function getEffectiveTimeZone() @@ -996,7 +1188,9 @@ public function getEffectiveTimeZone() /** * Sets effective_time_zone + * * @param string $effective_time_zone + * * @return $this */ public function setEffectiveTimeZone($effective_time_zone) @@ -1008,6 +1202,7 @@ public function setEffectiveTimeZone($effective_time_zone) /** * Gets initial_format + * * @return string */ public function getInitialFormat() @@ -1017,7 +1212,9 @@ public function getInitialFormat() /** * Sets initial_format + * * @param string $initial_format + * * @return $this */ public function setInitialFormat($initial_format) @@ -1029,6 +1226,7 @@ public function setInitialFormat($initial_format) /** * Gets initial_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getInitialFormatMetadata() @@ -1038,7 +1236,9 @@ public function getInitialFormatMetadata() /** * Sets initial_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $initial_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $initial_format_metadata initial_format_metadata + * * @return $this */ public function setInitialFormatMetadata($initial_format_metadata) @@ -1050,6 +1250,7 @@ public function setInitialFormatMetadata($initial_format_metadata) /** * Gets name_format + * * @return string */ public function getNameFormat() @@ -1059,7 +1260,9 @@ public function getNameFormat() /** * Sets name_format + * * @param string $name_format + * * @return $this */ public function setNameFormat($name_format) @@ -1071,6 +1274,7 @@ public function setNameFormat($name_format) /** * Gets name_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getNameFormatMetadata() @@ -1080,7 +1284,9 @@ public function getNameFormatMetadata() /** * Sets name_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $name_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $name_format_metadata name_format_metadata + * * @return $this */ public function setNameFormatMetadata($name_format_metadata) @@ -1092,6 +1298,7 @@ public function setNameFormatMetadata($name_format_metadata) /** * Gets sign_date_format + * * @return string */ public function getSignDateFormat() @@ -1101,7 +1308,9 @@ public function getSignDateFormat() /** * Sets sign_date_format + * * @param string $sign_date_format + * * @return $this */ public function setSignDateFormat($sign_date_format) @@ -1113,6 +1322,7 @@ public function setSignDateFormat($sign_date_format) /** * Gets sign_date_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignDateFormatMetadata() @@ -1122,7 +1332,9 @@ public function getSignDateFormatMetadata() /** * Sets sign_date_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sign_date_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sign_date_format_metadata sign_date_format_metadata + * * @return $this */ public function setSignDateFormatMetadata($sign_date_format_metadata) @@ -1134,6 +1346,7 @@ public function setSignDateFormatMetadata($sign_date_format_metadata) /** * Gets sign_time_format + * * @return string */ public function getSignTimeFormat() @@ -1143,7 +1356,9 @@ public function getSignTimeFormat() /** * Sets sign_time_format + * * @param string $sign_time_format + * * @return $this */ public function setSignTimeFormat($sign_time_format) @@ -1155,6 +1370,7 @@ public function setSignTimeFormat($sign_time_format) /** * Gets sign_time_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSignTimeFormatMetadata() @@ -1164,7 +1380,9 @@ public function getSignTimeFormatMetadata() /** * Sets sign_time_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sign_time_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sign_time_format_metadata sign_time_format_metadata + * * @return $this */ public function setSignTimeFormatMetadata($sign_time_format_metadata) @@ -1176,6 +1394,7 @@ public function setSignTimeFormatMetadata($sign_time_format_metadata) /** * Gets time_format + * * @return string */ public function getTimeFormat() @@ -1185,7 +1404,9 @@ public function getTimeFormat() /** * Sets time_format + * * @param string $time_format + * * @return $this */ public function setTimeFormat($time_format) @@ -1197,6 +1418,7 @@ public function setTimeFormat($time_format) /** * Gets time_format_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTimeFormatMetadata() @@ -1206,7 +1428,9 @@ public function getTimeFormatMetadata() /** * Sets time_format_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $time_format_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $time_format_metadata time_format_metadata + * * @return $this */ public function setTimeFormatMetadata($time_format_metadata) @@ -1218,6 +1442,7 @@ public function setTimeFormatMetadata($time_format_metadata) /** * Gets time_zone + * * @return string */ public function getTimeZone() @@ -1227,7 +1452,9 @@ public function getTimeZone() /** * Sets time_zone + * * @param string $time_zone + * * @return $this */ public function setTimeZone($time_zone) @@ -1239,6 +1466,7 @@ public function setTimeZone($time_zone) /** * Gets time_zone_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTimeZoneMetadata() @@ -1248,7 +1476,9 @@ public function getTimeZoneMetadata() /** * Sets time_zone_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $time_zone_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $time_zone_metadata time_zone_metadata + * * @return $this */ public function setTimeZoneMetadata($time_zone_metadata) @@ -1259,7 +1489,9 @@ public function setTimeZoneMetadata($time_zone_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1269,7 +1501,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1279,8 +1513,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1294,7 +1530,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1304,16 +1542,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/LocalePolicyTab.php b/src/Model/LocalePolicyTab.php index 8baad0ed..af7c488f 100644 --- a/src/Model/LocalePolicyTab.php +++ b/src/Model/LocalePolicyTab.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * LocalePolicyTab Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class LocalePolicyTab implements ArrayAccess +class LocalePolicyTab implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'localePolicyTab'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -68,13 +71,50 @@ class LocalePolicyTab implements ArrayAccess 'time_zone' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address_format' => null, + 'calendar_type' => null, + 'culture_name' => null, + 'currency_negative_format' => null, + 'currency_positive_format' => null, + 'custom_date_format' => null, + 'custom_time_format' => null, + 'date_format' => null, + 'initial_format' => null, + 'name_format' => null, + 'time_format' => null, + 'time_zone' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -92,9 +132,9 @@ public static function swaggerTypes() 'time_zone' => 'timeZone' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,9 +152,9 @@ public static function swaggerTypes() 'time_zone' => 'setTimeZone' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -132,34 +172,63 @@ public static function swaggerTypes() 'time_zone' => 'getTimeZone' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -178,30 +247,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address_format + * * @return string */ public function getAddressFormat() @@ -211,7 +282,9 @@ public function getAddressFormat() /** * Sets address_format + * * @param string $address_format + * * @return $this */ public function setAddressFormat($address_format) @@ -223,6 +296,7 @@ public function setAddressFormat($address_format) /** * Gets calendar_type + * * @return string */ public function getCalendarType() @@ -232,7 +306,9 @@ public function getCalendarType() /** * Sets calendar_type + * * @param string $calendar_type + * * @return $this */ public function setCalendarType($calendar_type) @@ -244,6 +320,7 @@ public function setCalendarType($calendar_type) /** * Gets culture_name + * * @return string */ public function getCultureName() @@ -253,7 +330,9 @@ public function getCultureName() /** * Sets culture_name + * * @param string $culture_name + * * @return $this */ public function setCultureName($culture_name) @@ -265,6 +344,7 @@ public function setCultureName($culture_name) /** * Gets currency_negative_format + * * @return string */ public function getCurrencyNegativeFormat() @@ -274,7 +354,9 @@ public function getCurrencyNegativeFormat() /** * Sets currency_negative_format + * * @param string $currency_negative_format + * * @return $this */ public function setCurrencyNegativeFormat($currency_negative_format) @@ -286,6 +368,7 @@ public function setCurrencyNegativeFormat($currency_negative_format) /** * Gets currency_positive_format + * * @return string */ public function getCurrencyPositiveFormat() @@ -295,7 +378,9 @@ public function getCurrencyPositiveFormat() /** * Sets currency_positive_format + * * @param string $currency_positive_format + * * @return $this */ public function setCurrencyPositiveFormat($currency_positive_format) @@ -307,6 +392,7 @@ public function setCurrencyPositiveFormat($currency_positive_format) /** * Gets custom_date_format + * * @return string */ public function getCustomDateFormat() @@ -316,7 +402,9 @@ public function getCustomDateFormat() /** * Sets custom_date_format + * * @param string $custom_date_format + * * @return $this */ public function setCustomDateFormat($custom_date_format) @@ -328,6 +416,7 @@ public function setCustomDateFormat($custom_date_format) /** * Gets custom_time_format + * * @return string */ public function getCustomTimeFormat() @@ -337,7 +426,9 @@ public function getCustomTimeFormat() /** * Sets custom_time_format + * * @param string $custom_time_format + * * @return $this */ public function setCustomTimeFormat($custom_time_format) @@ -349,6 +440,7 @@ public function setCustomTimeFormat($custom_time_format) /** * Gets date_format + * * @return string */ public function getDateFormat() @@ -358,7 +450,9 @@ public function getDateFormat() /** * Sets date_format + * * @param string $date_format + * * @return $this */ public function setDateFormat($date_format) @@ -370,6 +464,7 @@ public function setDateFormat($date_format) /** * Gets initial_format + * * @return string */ public function getInitialFormat() @@ -379,7 +474,9 @@ public function getInitialFormat() /** * Sets initial_format + * * @param string $initial_format + * * @return $this */ public function setInitialFormat($initial_format) @@ -391,6 +488,7 @@ public function setInitialFormat($initial_format) /** * Gets name_format + * * @return string */ public function getNameFormat() @@ -400,7 +498,9 @@ public function getNameFormat() /** * Sets name_format + * * @param string $name_format + * * @return $this */ public function setNameFormat($name_format) @@ -412,6 +512,7 @@ public function setNameFormat($name_format) /** * Gets time_format + * * @return string */ public function getTimeFormat() @@ -421,7 +522,9 @@ public function getTimeFormat() /** * Sets time_format + * * @param string $time_format + * * @return $this */ public function setTimeFormat($time_format) @@ -433,6 +536,7 @@ public function setTimeFormat($time_format) /** * Gets time_zone + * * @return string */ public function getTimeZone() @@ -442,7 +546,9 @@ public function getTimeZone() /** * Sets time_zone + * * @param string $time_zone + * * @return $this */ public function setTimeZone($time_zone) @@ -453,7 +559,9 @@ public function setTimeZone($time_zone) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -463,7 +571,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -473,8 +583,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -488,7 +600,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -498,16 +612,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/LockInformation.php b/src/Model/LockInformation.php index 2153ab2b..e470f248 100644 --- a/src/Model/LockInformation.php +++ b/src/Model/LockInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * LockInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class LockInformation implements ArrayAccess +class LockInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'lockInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class LockInformation implements ArrayAccess 'use_scratch_pad' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'lock_duration_in_seconds' => null, + 'locked_by_app' => null, + 'locked_by_user' => null, + 'locked_until_date_time' => null, + 'lock_token' => null, + 'lock_type' => null, + 'use_scratch_pad' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'use_scratch_pad' => 'useScratchPad' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'use_scratch_pad' => 'setUseScratchPad' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'use_scratch_pad' => 'getUseScratchPad' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -191,7 +258,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -203,6 +272,7 @@ public function setErrorDetails($error_details) /** * Gets lock_duration_in_seconds + * * @return string */ public function getLockDurationInSeconds() @@ -212,7 +282,9 @@ public function getLockDurationInSeconds() /** * Sets lock_duration_in_seconds + * * @param string $lock_duration_in_seconds Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended. + * * @return $this */ public function setLockDurationInSeconds($lock_duration_in_seconds) @@ -224,6 +296,7 @@ public function setLockDurationInSeconds($lock_duration_in_seconds) /** * Gets locked_by_app + * * @return string */ public function getLockedByApp() @@ -233,7 +306,9 @@ public function getLockedByApp() /** * Sets locked_by_app + * * @param string $locked_by_app Specifies the friendly name of the application that is locking the envelope. + * * @return $this */ public function setLockedByApp($locked_by_app) @@ -245,6 +320,7 @@ public function setLockedByApp($locked_by_app) /** * Gets locked_by_user + * * @return \DocuSign\eSign\Model\UserInfo */ public function getLockedByUser() @@ -254,7 +330,9 @@ public function getLockedByUser() /** * Sets locked_by_user - * @param \DocuSign\eSign\Model\UserInfo $locked_by_user + * + * @param \DocuSign\eSign\Model\UserInfo $locked_by_user locked_by_user + * * @return $this */ public function setLockedByUser($locked_by_user) @@ -266,6 +344,7 @@ public function setLockedByUser($locked_by_user) /** * Gets locked_until_date_time + * * @return string */ public function getLockedUntilDateTime() @@ -275,7 +354,9 @@ public function getLockedUntilDateTime() /** * Sets locked_until_date_time + * * @param string $locked_until_date_time The datetime until the envelope lock expires. + * * @return $this */ public function setLockedUntilDateTime($locked_until_date_time) @@ -287,6 +368,7 @@ public function setLockedUntilDateTime($locked_until_date_time) /** * Gets lock_token + * * @return string */ public function getLockToken() @@ -296,7 +378,9 @@ public function getLockToken() /** * Sets lock_token + * * @param string $lock_token A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock. + * * @return $this */ public function setLockToken($lock_token) @@ -308,6 +392,7 @@ public function setLockToken($lock_token) /** * Gets lock_type + * * @return string */ public function getLockType() @@ -317,7 +402,9 @@ public function getLockType() /** * Sets lock_type + * * @param string $lock_type The type of envelope lock. Currently \"edit\" is the only supported type. + * * @return $this */ public function setLockType($lock_type) @@ -329,6 +416,7 @@ public function setLockType($lock_type) /** * Gets use_scratch_pad + * * @return string */ public function getUseScratchPad() @@ -338,7 +426,9 @@ public function getUseScratchPad() /** * Sets use_scratch_pad + * * @param string $use_scratch_pad Reserved for future use. Indicates whether a scratchpad is used for editing information. + * * @return $this */ public function setUseScratchPad($use_scratch_pad) @@ -349,7 +439,9 @@ public function setUseScratchPad($use_scratch_pad) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/LockRequest.php b/src/Model/LockRequest.php index dbb3d2d3..5daf2748 100644 --- a/src/Model/LockRequest.php +++ b/src/Model/LockRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * LockRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class LockRequest implements ArrayAccess +class LockRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'lockRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class LockRequest implements ArrayAccess 'use_scratch_pad' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'lock_duration_in_seconds' => null, + 'locked_by_app' => null, + 'lock_type' => null, + 'template_password' => null, + 'use_scratch_pad' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'use_scratch_pad' => 'useScratchPad' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'use_scratch_pad' => 'setUseScratchPad' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'use_scratch_pad' => 'getUseScratchPad' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets lock_duration_in_seconds + * * @return string */ public function getLockDurationInSeconds() @@ -176,7 +240,9 @@ public function getLockDurationInSeconds() /** * Sets lock_duration_in_seconds + * * @param string $lock_duration_in_seconds The number of seconds to lock the envelope for editing. Must be greater than 0 seconds. + * * @return $this */ public function setLockDurationInSeconds($lock_duration_in_seconds) @@ -188,6 +254,7 @@ public function setLockDurationInSeconds($lock_duration_in_seconds) /** * Gets locked_by_app + * * @return string */ public function getLockedByApp() @@ -197,7 +264,9 @@ public function getLockedByApp() /** * Sets locked_by_app + * * @param string $locked_by_app A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur. + * * @return $this */ public function setLockedByApp($locked_by_app) @@ -209,6 +278,7 @@ public function setLockedByApp($locked_by_app) /** * Gets lock_type + * * @return string */ public function getLockType() @@ -218,7 +288,9 @@ public function getLockType() /** * Sets lock_type + * * @param string $lock_type The type of envelope lock. Currently \"edit\" is the only supported type. + * * @return $this */ public function setLockType($lock_type) @@ -230,6 +302,7 @@ public function setLockType($lock_type) /** * Gets template_password + * * @return string */ public function getTemplatePassword() @@ -239,7 +312,9 @@ public function getTemplatePassword() /** * Sets template_password + * * @param string $template_password + * * @return $this */ public function setTemplatePassword($template_password) @@ -251,6 +326,7 @@ public function setTemplatePassword($template_password) /** * Gets use_scratch_pad + * * @return string */ public function getUseScratchPad() @@ -260,7 +336,9 @@ public function getUseScratchPad() /** * Sets use_scratch_pad + * * @param string $use_scratch_pad Reserved for future use. Indicates whether a scratchpad is used for editing information. + * * @return $this */ public function setUseScratchPad($use_scratch_pad) @@ -271,7 +349,9 @@ public function setUseScratchPad($use_scratch_pad) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/LoginAccount.php b/src/Model/LoginAccount.php index fb8db7d2..1b0ea752 100644 --- a/src/Model/LoginAccount.php +++ b/src/Model/LoginAccount.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * LoginAccount Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class LoginAccount implements ArrayAccess +class LoginAccount implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'loginAccount'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -67,13 +70,49 @@ class LoginAccount implements ArrayAccess 'user_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_id' => null, + 'account_id_guid' => null, + 'base_url' => null, + 'email' => null, + 'is_default' => null, + 'login_account_settings' => null, + 'login_user_settings' => null, + 'name' => null, + 'site_description' => null, + 'user_id' => null, + 'user_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -90,9 +129,9 @@ public static function swaggerTypes() 'user_name' => 'userName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -109,9 +148,9 @@ public static function swaggerTypes() 'user_name' => 'setUserName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -128,34 +167,63 @@ public static function swaggerTypes() 'user_name' => 'getUserName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -173,30 +241,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_id + * * @return string */ public function getAccountId() @@ -206,7 +276,9 @@ public function getAccountId() /** * Sets account_id + * * @param string $account_id The account ID associated with the envelope. + * * @return $this */ public function setAccountId($account_id) @@ -218,6 +290,7 @@ public function setAccountId($account_id) /** * Gets account_id_guid + * * @return string */ public function getAccountIdGuid() @@ -227,7 +300,9 @@ public function getAccountIdGuid() /** * Sets account_id_guid + * * @param string $account_id_guid The GUID associated with the account ID. + * * @return $this */ public function setAccountIdGuid($account_id_guid) @@ -239,6 +314,7 @@ public function setAccountIdGuid($account_id_guid) /** * Gets base_url + * * @return string */ public function getBaseUrl() @@ -248,7 +324,9 @@ public function getBaseUrl() /** * Sets base_url + * * @param string $base_url The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl. + * * @return $this */ public function setBaseUrl($base_url) @@ -260,6 +338,7 @@ public function setBaseUrl($base_url) /** * Gets email + * * @return string */ public function getEmail() @@ -269,7 +348,9 @@ public function getEmail() /** * Sets email + * * @param string $email The email address for the user. + * * @return $this */ public function setEmail($email) @@ -281,6 +362,7 @@ public function setEmail($email) /** * Gets is_default + * * @return string */ public function getIsDefault() @@ -290,7 +372,9 @@ public function getIsDefault() /** * Sets is_default + * * @param string $is_default This value is true if this is the default account for the user, otherwise false is returned. + * * @return $this */ public function setIsDefault($is_default) @@ -302,6 +386,7 @@ public function setIsDefault($is_default) /** * Gets login_account_settings + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getLoginAccountSettings() @@ -311,7 +396,9 @@ public function getLoginAccountSettings() /** * Sets login_account_settings + * * @param \DocuSign\eSign\Model\NameValue[] $login_account_settings A list of settings on the acccount that indicate what features are available. + * * @return $this */ public function setLoginAccountSettings($login_account_settings) @@ -323,6 +410,7 @@ public function setLoginAccountSettings($login_account_settings) /** * Gets login_user_settings + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getLoginUserSettings() @@ -332,7 +420,9 @@ public function getLoginUserSettings() /** * Sets login_user_settings + * * @param \DocuSign\eSign\Model\NameValue[] $login_user_settings A list of user-level settings that indicate what user-specific features are available. + * * @return $this */ public function setLoginUserSettings($login_user_settings) @@ -344,6 +434,7 @@ public function setLoginUserSettings($login_user_settings) /** * Gets name + * * @return string */ public function getName() @@ -353,7 +444,9 @@ public function getName() /** * Sets name + * * @param string $name The name associated with the account. + * * @return $this */ public function setName($name) @@ -365,6 +458,7 @@ public function setName($name) /** * Gets site_description + * * @return string */ public function getSiteDescription() @@ -374,7 +468,9 @@ public function getSiteDescription() /** * Sets site_description + * * @param string $site_description An optional descirption of the site that hosts the account. + * * @return $this */ public function setSiteDescription($site_description) @@ -386,6 +482,7 @@ public function setSiteDescription($site_description) /** * Gets user_id + * * @return string */ public function getUserId() @@ -395,7 +492,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -407,6 +506,7 @@ public function setUserId($user_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -416,7 +516,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name The name of this user as defined by the account. + * * @return $this */ public function setUserName($user_name) @@ -427,7 +529,9 @@ public function setUserName($user_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -437,7 +541,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -447,8 +553,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -462,7 +570,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -472,16 +582,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/LoginInformation.php b/src/Model/LoginInformation.php index b5125499..4d4b005c 100644 --- a/src/Model/LoginInformation.php +++ b/src/Model/LoginInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * LoginInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class LoginInformation implements ArrayAccess +class LoginInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'loginInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class LoginInformation implements ArrayAccess 'login_accounts' => '\DocuSign\eSign\Model\LoginAccount[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'api_password' => null, + 'login_accounts' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'login_accounts' => 'loginAccounts' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'login_accounts' => 'setLoginAccounts' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'login_accounts' => 'getLoginAccounts' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets api_password + * * @return string */ public function getApiPassword() @@ -161,7 +222,9 @@ public function getApiPassword() /** * Sets api_password + * * @param string $api_password Contains a token that can be used for authentication in API calls instead of using the user name and password. Only returned if the `api_password=true` query string is added to the URL. + * * @return $this */ public function setApiPassword($api_password) @@ -173,6 +236,7 @@ public function setApiPassword($api_password) /** * Gets login_accounts + * * @return \DocuSign\eSign\Model\LoginAccount[] */ public function getLoginAccounts() @@ -182,7 +246,9 @@ public function getLoginAccounts() /** * Sets login_accounts + * * @param \DocuSign\eSign\Model\LoginAccount[] $login_accounts The list of accounts that authenticating user is a member of. + * * @return $this */ public function setLoginAccounts($login_accounts) @@ -193,7 +259,9 @@ public function setLoginAccounts($login_accounts) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/MatchBox.php b/src/Model/MatchBox.php index 9fe65cc6..edb9a60c 100644 --- a/src/Model/MatchBox.php +++ b/src/Model/MatchBox.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * MatchBox Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class MatchBox implements ArrayAccess +class MatchBox implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'matchBox'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class MatchBox implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'height' => null, + 'page_number' => null, + 'width' => null, + 'x_position' => null, + 'y_position' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'y_position' => 'getYPosition' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets height + * * @return string */ public function getHeight() @@ -176,7 +240,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -188,6 +254,7 @@ public function setHeight($height) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -197,7 +264,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -209,6 +278,7 @@ public function setPageNumber($page_number) /** * Gets width + * * @return string */ public function getWidth() @@ -218,7 +288,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -230,6 +302,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -239,7 +312,9 @@ public function getXPosition() /** * 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) @@ -251,6 +326,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -260,7 +336,9 @@ public function getYPosition() /** * 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) @@ -271,7 +349,9 @@ public function setYPosition($y_position) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/MemberGroupSharedItem.php b/src/Model/MemberGroupSharedItem.php index 3c1211a2..14103300 100644 --- a/src/Model/MemberGroupSharedItem.php +++ b/src/Model/MemberGroupSharedItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * MemberGroupSharedItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class MemberGroupSharedItem implements ArrayAccess +class MemberGroupSharedItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'memberGroupSharedItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class MemberGroupSharedItem implements ArrayAccess 'shared' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'group' => null, + 'shared' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'shared' => 'shared' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'shared' => 'setShared' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'shared' => 'getShared' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -166,7 +228,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -178,6 +242,7 @@ public function setErrorDetails($error_details) /** * Gets group + * * @return \DocuSign\eSign\Model\Group */ public function getGroup() @@ -187,7 +252,9 @@ public function getGroup() /** * Sets group - * @param \DocuSign\eSign\Model\Group $group + * + * @param \DocuSign\eSign\Model\Group $group group + * * @return $this */ public function setGroup($group) @@ -199,6 +266,7 @@ public function setGroup($group) /** * Gets shared + * * @return string */ public function getShared() @@ -208,7 +276,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -219,7 +289,9 @@ public function setShared($shared) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/MemberSharedItems.php b/src/Model/MemberSharedItems.php index e327b7af..91574d86 100644 --- a/src/Model/MemberSharedItems.php +++ b/src/Model/MemberSharedItems.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * MemberSharedItems Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class MemberSharedItems implements ArrayAccess +class MemberSharedItems implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'memberSharedItems'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class MemberSharedItems implements ArrayAccess 'user' => '\DocuSign\eSign\Model\UserInfo' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelopes' => null, + 'error_details' => null, + 'folders' => null, + 'templates' => null, + 'user' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'user' => 'user' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'user' => 'setUser' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'user' => 'getUser' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelopes + * * @return \DocuSign\eSign\Model\SharedItem[] */ public function getEnvelopes() @@ -176,7 +240,9 @@ public function getEnvelopes() /** * Sets envelopes + * * @param \DocuSign\eSign\Model\SharedItem[] $envelopes + * * @return $this */ public function setEnvelopes($envelopes) @@ -188,6 +254,7 @@ public function setEnvelopes($envelopes) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -197,7 +264,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -209,6 +278,7 @@ public function setErrorDetails($error_details) /** * Gets folders + * * @return \DocuSign\eSign\Model\FolderSharedItem[] */ public function getFolders() @@ -218,7 +288,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\FolderSharedItem[] $folders + * * @return $this */ public function setFolders($folders) @@ -230,6 +302,7 @@ public function setFolders($folders) /** * Gets templates + * * @return \DocuSign\eSign\Model\TemplateSharedItem[] */ public function getTemplates() @@ -239,7 +312,9 @@ public function getTemplates() /** * Sets templates + * * @param \DocuSign\eSign\Model\TemplateSharedItem[] $templates + * * @return $this */ public function setTemplates($templates) @@ -251,6 +326,7 @@ public function setTemplates($templates) /** * Gets user + * * @return \DocuSign\eSign\Model\UserInfo */ public function getUser() @@ -260,7 +336,9 @@ public function getUser() /** * Sets user - * @param \DocuSign\eSign\Model\UserInfo $user + * + * @param \DocuSign\eSign\Model\UserInfo $user user + * * @return $this */ public function setUser($user) @@ -271,7 +349,9 @@ public function setUser($user) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/MergeField.php b/src/Model/MergeField.php index 8e000f5b..9d4de119 100644 --- a/src/Model/MergeField.php +++ b/src/Model/MergeField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * MergeField Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class MergeField implements ArrayAccess +class MergeField implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'mergeField'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -69,13 +72,50 @@ class MergeField implements ArrayAccess 'write_back_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_sender_to_edit' => null, + 'allow_sender_to_edit_metadata' => null, + 'configuration_type' => null, + 'configuration_type_metadata' => null, + 'path' => null, + 'path_extended' => null, + 'path_extended_metadata' => null, + 'path_metadata' => null, + 'row' => null, + 'row_metadata' => null, + 'write_back' => null, + 'write_back_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -93,9 +133,9 @@ public static function swaggerTypes() 'write_back_metadata' => 'writeBackMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -113,9 +153,9 @@ public static function swaggerTypes() 'write_back_metadata' => 'setWriteBackMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -133,34 +173,63 @@ public static function swaggerTypes() 'write_back_metadata' => 'getWriteBackMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -179,30 +248,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allow_sender_to_edit + * * @return string */ public function getAllowSenderToEdit() @@ -212,7 +283,9 @@ public function getAllowSenderToEdit() /** * Sets allow_sender_to_edit + * * @param string $allow_sender_to_edit When set to **true**, the sender can modify the value of the custom tab during the sending process. + * * @return $this */ public function setAllowSenderToEdit($allow_sender_to_edit) @@ -224,6 +297,7 @@ public function setAllowSenderToEdit($allow_sender_to_edit) /** * Gets allow_sender_to_edit_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAllowSenderToEditMetadata() @@ -233,7 +307,9 @@ public function getAllowSenderToEditMetadata() /** * Sets allow_sender_to_edit_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $allow_sender_to_edit_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $allow_sender_to_edit_metadata allow_sender_to_edit_metadata + * * @return $this */ public function setAllowSenderToEditMetadata($allow_sender_to_edit_metadata) @@ -245,6 +321,7 @@ public function setAllowSenderToEditMetadata($allow_sender_to_edit_metadata) /** * Gets configuration_type + * * @return string */ public function getConfigurationType() @@ -254,7 +331,9 @@ public function getConfigurationType() /** * Sets configuration_type + * * @param string $configuration_type If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. + * * @return $this */ public function setConfigurationType($configuration_type) @@ -266,6 +345,7 @@ public function setConfigurationType($configuration_type) /** * Gets configuration_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConfigurationTypeMetadata() @@ -275,7 +355,9 @@ public function getConfigurationTypeMetadata() /** * Sets configuration_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $configuration_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $configuration_type_metadata configuration_type_metadata + * * @return $this */ public function setConfigurationTypeMetadata($configuration_type_metadata) @@ -287,6 +369,7 @@ public function setConfigurationTypeMetadata($configuration_type_metadata) /** * Gets path + * * @return string */ public function getPath() @@ -296,7 +379,9 @@ public function getPath() /** * Sets path + * * @param string $path Sets the object associated with the custom tab. Currently this is the Salesforce Object. + * * @return $this */ public function setPath($path) @@ -308,6 +393,7 @@ public function setPath($path) /** * Gets path_extended + * * @return \DocuSign\eSign\Model\PathExtendedElement[] */ public function getPathExtended() @@ -317,7 +403,9 @@ public function getPathExtended() /** * Sets path_extended + * * @param \DocuSign\eSign\Model\PathExtendedElement[] $path_extended + * * @return $this */ public function setPathExtended($path_extended) @@ -329,6 +417,7 @@ public function setPathExtended($path_extended) /** * Gets path_extended_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPathExtendedMetadata() @@ -338,7 +427,9 @@ public function getPathExtendedMetadata() /** * Sets path_extended_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $path_extended_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $path_extended_metadata path_extended_metadata + * * @return $this */ public function setPathExtendedMetadata($path_extended_metadata) @@ -350,6 +441,7 @@ public function setPathExtendedMetadata($path_extended_metadata) /** * Gets path_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPathMetadata() @@ -359,7 +451,9 @@ public function getPathMetadata() /** * Sets path_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $path_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $path_metadata path_metadata + * * @return $this */ public function setPathMetadata($path_metadata) @@ -371,6 +465,7 @@ public function setPathMetadata($path_metadata) /** * Gets row + * * @return string */ public function getRow() @@ -380,7 +475,9 @@ public function getRow() /** * Sets row + * * @param string $row Specifies the row number in a Salesforce table that the merge field value corresponds to. + * * @return $this */ public function setRow($row) @@ -392,6 +489,7 @@ public function setRow($row) /** * Gets row_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRowMetadata() @@ -401,7 +499,9 @@ public function getRowMetadata() /** * Sets row_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $row_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $row_metadata row_metadata + * * @return $this */ public function setRowMetadata($row_metadata) @@ -413,6 +513,7 @@ public function setRowMetadata($row_metadata) /** * Gets write_back + * * @return string */ public function getWriteBack() @@ -422,7 +523,9 @@ public function getWriteBack() /** * Sets write_back + * * @param string $write_back When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. + * * @return $this */ public function setWriteBack($write_back) @@ -434,6 +537,7 @@ public function setWriteBack($write_back) /** * Gets write_back_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWriteBackMetadata() @@ -443,7 +547,9 @@ public function getWriteBackMetadata() /** * Sets write_back_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $write_back_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $write_back_metadata write_back_metadata + * * @return $this */ public function setWriteBackMetadata($write_back_metadata) @@ -454,7 +560,9 @@ public function setWriteBackMetadata($write_back_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -464,7 +572,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -474,8 +584,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -489,7 +601,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -499,16 +613,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/MobileNotifierConfiguration.php b/src/Model/MobileNotifierConfiguration.php index 83e86c69..d650a61f 100644 --- a/src/Model/MobileNotifierConfiguration.php +++ b/src/Model/MobileNotifierConfiguration.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * MobileNotifierConfiguration Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class MobileNotifierConfiguration implements ArrayAccess +class MobileNotifierConfiguration implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'mobileNotifierConfiguration'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class MobileNotifierConfiguration implements ArrayAccess 'platform' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'device_id' => null, + 'error_details' => null, + 'platform' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'platform' => 'platform' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'platform' => 'setPlatform' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'platform' => 'getPlatform' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets device_id + * * @return string */ public function getDeviceId() @@ -166,7 +228,9 @@ public function getDeviceId() /** * Sets device_id + * * @param string $device_id + * * @return $this */ public function setDeviceId($device_id) @@ -178,6 +242,7 @@ public function setDeviceId($device_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -187,7 +252,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -199,6 +266,7 @@ public function setErrorDetails($error_details) /** * Gets platform + * * @return string */ public function getPlatform() @@ -208,7 +276,9 @@ public function getPlatform() /** * Sets platform + * * @param string $platform + * * @return $this */ public function setPlatform($platform) @@ -219,7 +289,9 @@ public function setPlatform($platform) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/MobileNotifierConfigurationInformation.php b/src/Model/MobileNotifierConfigurationInformation.php index 51dc989e..a4721879 100644 --- a/src/Model/MobileNotifierConfigurationInformation.php +++ b/src/Model/MobileNotifierConfigurationInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * MobileNotifierConfigurationInformation Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class MobileNotifierConfigurationInformation implements ArrayAccess +class MobileNotifierConfigurationInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'mobileNotifierConfigurationInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'mobile_notifier_configurations' => '\DocuSign\eSign\Model\MobileNotifierConfiguration[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'mobile_notifier_configurations' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'mobile_notifier_configurations' => 'mobileNotifierConfigurations' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'mobile_notifier_configurations' => 'setMobileNotifierConfigurations' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'mobile_notifier_configurations' => 'getMobileNotifierConfigurations' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets mobile_notifier_configurations + * * @return \DocuSign\eSign\Model\MobileNotifierConfiguration[] */ public function getMobileNotifierConfigurations() @@ -156,7 +216,9 @@ public function getMobileNotifierConfigurations() /** * Sets mobile_notifier_configurations + * * @param \DocuSign\eSign\Model\MobileNotifierConfiguration[] $mobile_notifier_configurations + * * @return $this */ public function setMobileNotifierConfigurations($mobile_notifier_configurations) @@ -167,7 +229,9 @@ public function setMobileNotifierConfigurations($mobile_notifier_configurations) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ModelInterface.php b/src/Model/ModelInterface.php new file mode 100644 index 00000000..044eb2f8 --- /dev/null +++ b/src/Model/ModelInterface.php @@ -0,0 +1,96 @@ + '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'list_items' => null, + 'list_selected_value' => null, + 'list_selected_value_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'require_all' => null, + 'require_all_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'sender_required' => null, + 'sender_required_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -268,9 +396,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -376,9 +504,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -484,34 +612,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -618,30 +775,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -651,7 +810,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -663,6 +824,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -672,7 +834,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -684,6 +848,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -693,7 +858,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -705,6 +872,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -714,7 +882,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -726,6 +896,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -735,7 +906,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -747,6 +920,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -756,7 +930,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -768,6 +944,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -777,7 +954,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -789,6 +968,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -798,7 +978,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -810,6 +992,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -819,7 +1002,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -831,6 +1016,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -840,7 +1026,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -852,6 +1040,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -861,7 +1050,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -873,6 +1064,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -882,7 +1074,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -894,6 +1088,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -903,7 +1098,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -915,6 +1112,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -924,7 +1122,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -936,6 +1136,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -945,7 +1146,9 @@ public function getAnchorUnits() /** * 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) @@ -957,6 +1160,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -966,7 +1170,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -978,6 +1184,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -987,7 +1194,9 @@ public function getAnchorXOffset() /** * 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) @@ -999,6 +1208,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1008,7 +1218,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1020,6 +1232,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1029,7 +1242,9 @@ public function getAnchorYOffset() /** * 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) @@ -1041,6 +1256,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1050,7 +1266,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1062,6 +1280,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1071,7 +1290,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1083,6 +1304,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1092,7 +1314,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1104,6 +1328,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1113,7 +1338,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1125,6 +1352,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1134,7 +1362,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1146,6 +1376,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1155,7 +1386,9 @@ public function getConditionalParentValue() /** * 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) @@ -1167,6 +1400,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1176,7 +1410,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1188,6 +1424,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1197,7 +1434,9 @@ public function getCustomTabId() /** * 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) @@ -1209,6 +1448,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1218,7 +1458,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1230,6 +1472,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1239,7 +1482,9 @@ public function getDocumentId() /** * 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) @@ -1251,6 +1496,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1260,7 +1506,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1272,6 +1520,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1281,7 +1530,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1293,6 +1544,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1302,7 +1554,9 @@ public function getFont() /** * 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) @@ -1314,6 +1568,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1323,7 +1578,9 @@ public function getFontColor() /** * 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) @@ -1335,6 +1592,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1344,7 +1602,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1356,6 +1616,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1365,7 +1626,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1377,6 +1640,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1386,7 +1650,9 @@ public function getFontSize() /** * 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) @@ -1398,6 +1664,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1407,7 +1674,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1419,6 +1688,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1428,7 +1698,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1440,6 +1712,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1449,7 +1722,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1461,6 +1736,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1470,7 +1746,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1482,6 +1760,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1491,7 +1770,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1503,6 +1784,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1512,7 +1794,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1524,6 +1808,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1533,7 +1818,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1545,6 +1832,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1554,7 +1842,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1566,6 +1856,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1575,7 +1866,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1587,6 +1880,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1596,7 +1890,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1608,6 +1904,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1617,7 +1914,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1629,6 +1928,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets list_items + * * @return \DocuSign\eSign\Model\ListItem[] */ public function getListItems() @@ -1638,7 +1938,9 @@ public function getListItems() /** * 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] Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters. + * * @return $this */ public function setListItems($list_items) @@ -1650,6 +1952,7 @@ public function setListItems($list_items) /** * Gets list_selected_value + * * @return string */ public function getListSelectedValue() @@ -1659,7 +1962,9 @@ public function getListSelectedValue() /** * Sets list_selected_value + * * @param string $list_selected_value + * * @return $this */ public function setListSelectedValue($list_selected_value) @@ -1671,6 +1976,7 @@ public function setListSelectedValue($list_selected_value) /** * Gets list_selected_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getListSelectedValueMetadata() @@ -1680,7 +1986,9 @@ public function getListSelectedValueMetadata() /** * Sets list_selected_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $list_selected_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $list_selected_value_metadata list_selected_value_metadata + * * @return $this */ public function setListSelectedValueMetadata($list_selected_value_metadata) @@ -1692,6 +2000,7 @@ public function setListSelectedValueMetadata($list_selected_value_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1701,7 +2010,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1713,6 +2024,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1722,7 +2034,9 @@ public function getLocked() /** * 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) @@ -1734,6 +2048,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1743,7 +2058,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1755,6 +2072,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1764,7 +2082,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1776,6 +2096,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1785,7 +2106,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1797,6 +2120,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1806,7 +2130,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1818,6 +2144,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1827,7 +2154,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1839,6 +2168,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1848,7 +2178,9 @@ public function getRecipientId() /** * 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) @@ -1860,6 +2192,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1869,7 +2202,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1881,6 +2216,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1890,7 +2226,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1902,6 +2240,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1911,7 +2250,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1923,6 +2264,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -1932,7 +2274,9 @@ public function getRequireAll() /** * 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) @@ -1944,6 +2288,7 @@ public function setRequireAll($require_all) /** * Gets require_all_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireAllMetadata() @@ -1953,7 +2298,9 @@ public function getRequireAllMetadata() /** * Sets require_all_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata require_all_metadata + * * @return $this */ public function setRequireAllMetadata($require_all_metadata) @@ -1965,6 +2312,7 @@ public function setRequireAllMetadata($require_all_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -1974,7 +2322,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -1986,6 +2336,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -1995,7 +2346,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2007,6 +2360,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -2016,7 +2370,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -2028,6 +2384,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -2037,7 +2394,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -2049,6 +2408,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -2058,7 +2418,9 @@ public function getSenderRequired() /** * 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. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + * * @return $this */ public function setSenderRequired($sender_required) @@ -2070,6 +2432,7 @@ public function setSenderRequired($sender_required) /** * Gets sender_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderRequiredMetadata() @@ -2079,7 +2442,9 @@ public function getSenderRequiredMetadata() /** * Sets sender_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata sender_required_metadata + * * @return $this */ public function setSenderRequiredMetadata($sender_required_metadata) @@ -2091,6 +2456,7 @@ public function setSenderRequiredMetadata($sender_required_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -2100,7 +2466,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -2112,6 +2480,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -2121,7 +2490,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -2133,6 +2504,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2142,7 +2514,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2154,6 +2528,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2163,7 +2538,9 @@ public function getStatus() /** * 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) @@ -2175,6 +2552,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2184,7 +2562,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2196,6 +2576,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2205,7 +2586,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2217,6 +2600,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2226,7 +2610,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2238,6 +2624,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2247,7 +2634,9 @@ public function getTabId() /** * 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) @@ -2259,6 +2648,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2268,7 +2658,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2280,6 +2672,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2289,7 +2682,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2301,6 +2696,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2310,7 +2706,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2322,6 +2720,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2331,7 +2730,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2343,6 +2744,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2352,7 +2754,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2364,6 +2768,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2373,7 +2778,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2385,6 +2792,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2394,7 +2802,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2406,6 +2816,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2415,7 +2826,9 @@ public function getTemplateLocked() /** * 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) @@ -2427,6 +2840,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2436,7 +2850,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2448,6 +2864,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2457,7 +2874,9 @@ public function getTemplateRequired() /** * 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) @@ -2469,6 +2888,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2478,7 +2898,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2490,6 +2912,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2499,7 +2922,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2511,6 +2936,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2520,7 +2946,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2532,6 +2960,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2541,7 +2970,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2553,6 +2984,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2562,7 +2994,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2574,6 +3008,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2583,7 +3018,9 @@ public function getValue() /** * Sets value + * * @param string $value The value to use when the item is selected. + * * @return $this */ public function setValue($value) @@ -2595,6 +3032,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2604,7 +3042,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2616,6 +3056,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2625,7 +3066,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2637,6 +3080,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2646,7 +3090,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2658,6 +3104,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2667,7 +3114,9 @@ public function getXPosition() /** * 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) @@ -2679,6 +3128,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2688,7 +3138,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2700,6 +3152,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2709,7 +3162,9 @@ public function getYPosition() /** * 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) @@ -2721,6 +3176,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2730,7 +3186,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2741,7 +3199,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2751,7 +3211,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2761,8 +3223,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2776,7 +3240,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2786,16 +3252,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Money.php b/src/Model/Money.php index d5eed71b..0d876dd2 100644 --- a/src/Model/Money.php +++ b/src/Model/Money.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Money Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Money implements ArrayAccess +class Money implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'money'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class Money implements ArrayAccess 'display_amount' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'amount_in_base_unit' => null, + 'currency' => null, + 'display_amount' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'display_amount' => 'displayAmount' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'display_amount' => 'setDisplayAmount' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'display_amount' => 'getDisplayAmount' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets amount_in_base_unit + * * @return string */ public function getAmountInBaseUnit() @@ -166,7 +228,9 @@ public function getAmountInBaseUnit() /** * Sets amount_in_base_unit + * * @param string $amount_in_base_unit + * * @return $this */ public function setAmountInBaseUnit($amount_in_base_unit) @@ -178,6 +242,7 @@ public function setAmountInBaseUnit($amount_in_base_unit) /** * Gets currency + * * @return string */ public function getCurrency() @@ -187,7 +252,9 @@ public function getCurrency() /** * Sets currency + * * @param string $currency + * * @return $this */ public function setCurrency($currency) @@ -199,6 +266,7 @@ public function setCurrency($currency) /** * Gets display_amount + * * @return string */ public function getDisplayAmount() @@ -208,7 +276,9 @@ public function getDisplayAmount() /** * Sets display_amount + * * @param string $display_amount + * * @return $this */ public function setDisplayAmount($display_amount) @@ -219,7 +289,9 @@ public function setDisplayAmount($display_amount) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NameValue.php b/src/Model/NameValue.php index fdee2ed0..907ff46f 100644 --- a/src/Model/NameValue.php +++ b/src/Model/NameValue.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NameValue Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NameValue implements ArrayAccess +class NameValue implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'nameValue'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class NameValue implements ArrayAccess 'value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'name' => null, + 'original_value' => null, + 'value' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'value' => 'value' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'value' => 'setValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'value' => 'getValue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -171,7 +234,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -183,6 +248,7 @@ public function setErrorDetails($error_details) /** * Gets name + * * @return string */ public function getName() @@ -192,7 +258,9 @@ public function getName() /** * Sets name + * * @param string $name The name or key of a name/value pair. + * * @return $this */ public function setName($name) @@ -204,6 +272,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -213,7 +282,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -225,6 +296,7 @@ public function setOriginalValue($original_value) /** * Gets value + * * @return string */ public function getValue() @@ -234,7 +306,9 @@ public function getValue() /** * Sets value + * * @param string $value The value field of a name/value pair. + * * @return $this */ public function setValue($value) @@ -245,7 +319,9 @@ public function setValue($value) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NewAccountDefinition.php b/src/Model/NewAccountDefinition.php index b4fadfab..13d973dc 100644 --- a/src/Model/NewAccountDefinition.php +++ b/src/Model/NewAccountDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NewAccountDefinition Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NewAccountDefinition implements ArrayAccess +class NewAccountDefinition implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'newAccountDefinition'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -70,13 +73,52 @@ class NewAccountDefinition implements ArrayAccess 'social_account_information' => '\DocuSign\eSign\Model\SocialAccountInformation' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_name' => null, + 'account_settings' => null, + 'address_information' => null, + 'credit_card_information' => null, + 'direct_debit_processor_information' => null, + 'distributor_code' => null, + 'distributor_password' => null, + 'envelope_partition_id' => null, + 'initial_user' => null, + 'payment_method' => null, + 'payment_processor_information' => null, + 'plan_information' => null, + 'referral_information' => null, + 'social_account_information' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -96,9 +138,9 @@ public static function swaggerTypes() 'social_account_information' => 'socialAccountInformation' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -118,9 +160,9 @@ public static function swaggerTypes() 'social_account_information' => 'setSocialAccountInformation' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -140,34 +182,63 @@ public static function swaggerTypes() 'social_account_information' => 'getSocialAccountInformation' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -188,30 +259,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_name + * * @return string */ public function getAccountName() @@ -221,7 +294,9 @@ public function getAccountName() /** * Sets account_name + * * @param string $account_name The account name for the new account. + * * @return $this */ public function setAccountName($account_name) @@ -233,6 +308,7 @@ public function setAccountName($account_name) /** * Gets account_settings + * * @return \DocuSign\eSign\Model\AccountSettingsInformation */ public function getAccountSettings() @@ -242,7 +318,9 @@ public function getAccountSettings() /** * Sets account_settings - * @param \DocuSign\eSign\Model\AccountSettingsInformation $account_settings + * + * @param \DocuSign\eSign\Model\AccountSettingsInformation $account_settings account_settings + * * @return $this */ public function setAccountSettings($account_settings) @@ -254,6 +332,7 @@ public function setAccountSettings($account_settings) /** * Gets address_information + * * @return \DocuSign\eSign\Model\AccountAddress */ public function getAddressInformation() @@ -263,7 +342,9 @@ public function getAddressInformation() /** * Sets address_information - * @param \DocuSign\eSign\Model\AccountAddress $address_information + * + * @param \DocuSign\eSign\Model\AccountAddress $address_information address_information + * * @return $this */ public function setAddressInformation($address_information) @@ -275,6 +356,7 @@ public function setAddressInformation($address_information) /** * Gets credit_card_information + * * @return \DocuSign\eSign\Model\CreditCardInformation */ public function getCreditCardInformation() @@ -284,7 +366,9 @@ public function getCreditCardInformation() /** * Sets credit_card_information - * @param \DocuSign\eSign\Model\CreditCardInformation $credit_card_information + * + * @param \DocuSign\eSign\Model\CreditCardInformation $credit_card_information credit_card_information + * * @return $this */ public function setCreditCardInformation($credit_card_information) @@ -296,6 +380,7 @@ public function setCreditCardInformation($credit_card_information) /** * Gets direct_debit_processor_information + * * @return \DocuSign\eSign\Model\DirectDebitProcessorInformation */ public function getDirectDebitProcessorInformation() @@ -305,7 +390,9 @@ public function getDirectDebitProcessorInformation() /** * Sets direct_debit_processor_information - * @param \DocuSign\eSign\Model\DirectDebitProcessorInformation $direct_debit_processor_information + * + * @param \DocuSign\eSign\Model\DirectDebitProcessorInformation $direct_debit_processor_information direct_debit_processor_information + * * @return $this */ public function setDirectDebitProcessorInformation($direct_debit_processor_information) @@ -317,6 +404,7 @@ public function setDirectDebitProcessorInformation($direct_debit_processor_infor /** * Gets distributor_code + * * @return string */ public function getDistributorCode() @@ -326,7 +414,9 @@ public function getDistributorCode() /** * Sets distributor_code + * * @param string $distributor_code The code that identifies the billing plan groups and plans for the new account. + * * @return $this */ public function setDistributorCode($distributor_code) @@ -338,6 +428,7 @@ public function setDistributorCode($distributor_code) /** * Gets distributor_password + * * @return string */ public function getDistributorPassword() @@ -347,7 +438,9 @@ public function getDistributorPassword() /** * Sets distributor_password + * * @param string $distributor_password The password for the distributorCode. + * * @return $this */ public function setDistributorPassword($distributor_password) @@ -359,6 +452,7 @@ public function setDistributorPassword($distributor_password) /** * Gets envelope_partition_id + * * @return string */ public function getEnvelopePartitionId() @@ -368,7 +462,9 @@ public function getEnvelopePartitionId() /** * Sets envelope_partition_id + * * @param string $envelope_partition_id + * * @return $this */ public function setEnvelopePartitionId($envelope_partition_id) @@ -380,6 +476,7 @@ public function setEnvelopePartitionId($envelope_partition_id) /** * Gets initial_user + * * @return \DocuSign\eSign\Model\UserInformation */ public function getInitialUser() @@ -389,7 +486,9 @@ public function getInitialUser() /** * Sets initial_user - * @param \DocuSign\eSign\Model\UserInformation $initial_user + * + * @param \DocuSign\eSign\Model\UserInformation $initial_user initial_user + * * @return $this */ public function setInitialUser($initial_user) @@ -401,6 +500,7 @@ public function setInitialUser($initial_user) /** * Gets payment_method + * * @return string */ public function getPaymentMethod() @@ -410,7 +510,9 @@ public function getPaymentMethod() /** * Sets payment_method + * * @param string $payment_method + * * @return $this */ public function setPaymentMethod($payment_method) @@ -422,6 +524,7 @@ public function setPaymentMethod($payment_method) /** * Gets payment_processor_information + * * @return \DocuSign\eSign\Model\PaymentProcessorInformation */ public function getPaymentProcessorInformation() @@ -431,7 +534,9 @@ public function getPaymentProcessorInformation() /** * Sets payment_processor_information - * @param \DocuSign\eSign\Model\PaymentProcessorInformation $payment_processor_information + * + * @param \DocuSign\eSign\Model\PaymentProcessorInformation $payment_processor_information payment_processor_information + * * @return $this */ public function setPaymentProcessorInformation($payment_processor_information) @@ -443,6 +548,7 @@ public function setPaymentProcessorInformation($payment_processor_information) /** * Gets plan_information + * * @return \DocuSign\eSign\Model\PlanInformation */ public function getPlanInformation() @@ -452,7 +558,9 @@ public function getPlanInformation() /** * Sets plan_information - * @param \DocuSign\eSign\Model\PlanInformation $plan_information + * + * @param \DocuSign\eSign\Model\PlanInformation $plan_information plan_information + * * @return $this */ public function setPlanInformation($plan_information) @@ -464,6 +572,7 @@ public function setPlanInformation($plan_information) /** * Gets referral_information + * * @return \DocuSign\eSign\Model\ReferralInformation */ public function getReferralInformation() @@ -473,7 +582,9 @@ public function getReferralInformation() /** * Sets referral_information - * @param \DocuSign\eSign\Model\ReferralInformation $referral_information + * + * @param \DocuSign\eSign\Model\ReferralInformation $referral_information referral_information + * * @return $this */ public function setReferralInformation($referral_information) @@ -485,6 +596,7 @@ public function setReferralInformation($referral_information) /** * Gets social_account_information + * * @return \DocuSign\eSign\Model\SocialAccountInformation */ public function getSocialAccountInformation() @@ -494,7 +606,9 @@ public function getSocialAccountInformation() /** * Sets social_account_information - * @param \DocuSign\eSign\Model\SocialAccountInformation $social_account_information + * + * @param \DocuSign\eSign\Model\SocialAccountInformation $social_account_information social_account_information + * * @return $this */ public function setSocialAccountInformation($social_account_information) @@ -505,7 +619,9 @@ public function setSocialAccountInformation($social_account_information) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -515,7 +631,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -525,8 +643,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -540,7 +660,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -550,16 +672,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NewAccountSummary.php b/src/Model/NewAccountSummary.php index 34d00f73..1f709b01 100644 --- a/src/Model/NewAccountSummary.php +++ b/src/Model/NewAccountSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NewAccountSummary Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NewAccountSummary implements ArrayAccess +class NewAccountSummary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'newAccountSummary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class NewAccountSummary implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_id' => null, + 'account_id_guid' => null, + 'account_name' => null, + 'api_password' => null, + 'base_url' => null, + 'billing_plan_preview' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_id + * * @return string */ public function getAccountId() @@ -186,7 +252,9 @@ public function getAccountId() /** * Sets account_id + * * @param string $account_id The account ID associated with the envelope. + * * @return $this */ public function setAccountId($account_id) @@ -198,6 +266,7 @@ public function setAccountId($account_id) /** * Gets account_id_guid + * * @return string */ public function getAccountIdGuid() @@ -207,7 +276,9 @@ public function getAccountIdGuid() /** * Sets account_id_guid + * * @param string $account_id_guid The GUID associated with the account ID. + * * @return $this */ public function setAccountIdGuid($account_id_guid) @@ -219,6 +290,7 @@ public function setAccountIdGuid($account_id_guid) /** * Gets account_name + * * @return string */ public function getAccountName() @@ -228,7 +300,9 @@ public function getAccountName() /** * Sets account_name + * * @param string $account_name The account name for the new account. + * * @return $this */ public function setAccountName($account_name) @@ -240,6 +314,7 @@ public function setAccountName($account_name) /** * Gets api_password + * * @return string */ public function getApiPassword() @@ -249,7 +324,9 @@ public function getApiPassword() /** * Sets api_password + * * @param string $api_password Contains a token that can be used for authentication in API calls instead of using the user name and password. + * * @return $this */ public function setApiPassword($api_password) @@ -261,6 +338,7 @@ public function setApiPassword($api_password) /** * Gets base_url + * * @return string */ public function getBaseUrl() @@ -270,7 +348,9 @@ public function getBaseUrl() /** * Sets base_url + * * @param string $base_url The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl. + * * @return $this */ public function setBaseUrl($base_url) @@ -282,6 +362,7 @@ public function setBaseUrl($base_url) /** * Gets billing_plan_preview + * * @return \DocuSign\eSign\Model\BillingPlanPreview */ public function getBillingPlanPreview() @@ -291,7 +372,9 @@ public function getBillingPlanPreview() /** * Sets billing_plan_preview - * @param \DocuSign\eSign\Model\BillingPlanPreview $billing_plan_preview + * + * @param \DocuSign\eSign\Model\BillingPlanPreview $billing_plan_preview billing_plan_preview + * * @return $this */ public function setBillingPlanPreview($billing_plan_preview) @@ -303,6 +386,7 @@ public function setBillingPlanPreview($billing_plan_preview) /** * Gets user_id + * * @return string */ public function getUserId() @@ -312,7 +396,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id Specifies the user ID of the new user. + * * @return $this */ public function setUserId($user_id) @@ -323,7 +409,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NewUser.php b/src/Model/NewUser.php index 864ad41a..8ebcc769 100644 --- a/src/Model/NewUser.php +++ b/src/Model/NewUser.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NewUser Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NewUser implements ArrayAccess +class NewUser implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'newUser'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class NewUser implements ArrayAccess 'user_status' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'api_password' => null, + 'created_date_time' => null, + 'email' => null, + 'error_details' => null, + 'permission_profile_id' => null, + 'permission_profile_name' => null, + 'uri' => null, + 'user_id' => null, + 'user_name' => null, + 'user_status' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'user_status' => 'userStatus' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'user_status' => 'setUserStatus' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'user_status' => 'getUserStatus' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets api_password + * * @return string */ public function getApiPassword() @@ -201,7 +270,9 @@ public function getApiPassword() /** * Sets api_password + * * @param string $api_password Contains a token that can be used for authentication in API calls instead of using the user name and password. + * * @return $this */ public function setApiPassword($api_password) @@ -213,6 +284,7 @@ public function setApiPassword($api_password) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -222,7 +294,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -234,6 +308,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets email + * * @return string */ public function getEmail() @@ -243,7 +318,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -255,6 +332,7 @@ public function setEmail($email) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -264,7 +342,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -276,6 +356,7 @@ public function setErrorDetails($error_details) /** * Gets permission_profile_id + * * @return string */ public function getPermissionProfileId() @@ -285,7 +366,9 @@ public function getPermissionProfileId() /** * Sets permission_profile_id + * * @param string $permission_profile_id + * * @return $this */ public function setPermissionProfileId($permission_profile_id) @@ -297,6 +380,7 @@ public function setPermissionProfileId($permission_profile_id) /** * Gets permission_profile_name + * * @return string */ public function getPermissionProfileName() @@ -306,7 +390,9 @@ public function getPermissionProfileName() /** * Sets permission_profile_name + * * @param string $permission_profile_name + * * @return $this */ public function setPermissionProfileName($permission_profile_name) @@ -318,6 +404,7 @@ public function setPermissionProfileName($permission_profile_name) /** * Gets uri + * * @return string */ public function getUri() @@ -327,7 +414,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -339,6 +428,7 @@ public function setUri($uri) /** * Gets user_id + * * @return string */ public function getUserId() @@ -348,7 +438,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id Specifies the user ID for the new user. + * * @return $this */ public function setUserId($user_id) @@ -360,6 +452,7 @@ public function setUserId($user_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -369,7 +462,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -381,6 +476,7 @@ public function setUserName($user_name) /** * Gets user_status + * * @return string */ public function getUserStatus() @@ -390,7 +486,9 @@ public function getUserStatus() /** * Sets user_status + * * @param string $user_status + * * @return $this */ public function setUserStatus($user_status) @@ -401,7 +499,9 @@ public function setUserStatus($user_status) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NewUsersDefinition.php b/src/Model/NewUsersDefinition.php index ed473f36..6f7e5d83 100644 --- a/src/Model/NewUsersDefinition.php +++ b/src/Model/NewUsersDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NewUsersDefinition Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NewUsersDefinition implements ArrayAccess +class NewUsersDefinition implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'newUsersDefinition'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'new_users' => '\DocuSign\eSign\Model\UserInformation[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'new_users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'new_users' => 'newUsers' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'new_users' => 'setNewUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'new_users' => 'getNewUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets new_users + * * @return \DocuSign\eSign\Model\UserInformation[] */ public function getNewUsers() @@ -156,7 +216,9 @@ public function getNewUsers() /** * Sets new_users + * * @param \DocuSign\eSign\Model\UserInformation[] $new_users + * * @return $this */ public function setNewUsers($new_users) @@ -167,7 +229,9 @@ public function setNewUsers($new_users) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NewUsersSummary.php b/src/Model/NewUsersSummary.php index 119bab15..b608f99d 100644 --- a/src/Model/NewUsersSummary.php +++ b/src/Model/NewUsersSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NewUsersSummary Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NewUsersSummary implements ArrayAccess +class NewUsersSummary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'newUsersSummary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'new_users' => '\DocuSign\eSign\Model\NewUser[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'new_users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'new_users' => 'newUsers' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'new_users' => 'setNewUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'new_users' => 'getNewUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets new_users + * * @return \DocuSign\eSign\Model\NewUser[] */ public function getNewUsers() @@ -156,7 +216,9 @@ public function getNewUsers() /** * Sets new_users + * * @param \DocuSign\eSign\Model\NewUser[] $new_users + * * @return $this */ public function setNewUsers($new_users) @@ -167,7 +229,9 @@ public function setNewUsers($new_users) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Notarize.php b/src/Model/Notarize.php index f41015d6..04a5f9a1 100644 --- a/src/Model/Notarize.php +++ b/src/Model/Notarize.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Notarize Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Notarize implements ArrayAccess +class Notarize implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notarize'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -128,13 +131,110 @@ class Notarize implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'locked' => null, + 'locked_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -212,9 +312,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -292,9 +392,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -372,34 +472,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -478,30 +607,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -511,7 +642,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -523,6 +656,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -532,7 +666,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -544,6 +680,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -553,7 +690,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -565,6 +704,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -574,7 +714,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -586,6 +728,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -595,7 +738,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -607,6 +752,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -616,7 +762,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -628,6 +776,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -637,7 +786,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -649,6 +800,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -658,7 +810,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -670,6 +824,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -679,7 +834,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -691,6 +848,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -700,7 +858,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -712,6 +872,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -721,7 +882,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -733,6 +896,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -742,7 +906,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -754,6 +920,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -763,7 +930,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -775,6 +944,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -784,7 +954,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -796,6 +968,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -805,7 +978,9 @@ public function getAnchorUnits() /** * 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) @@ -817,6 +992,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -826,7 +1002,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -838,6 +1016,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -847,7 +1026,9 @@ public function getAnchorXOffset() /** * 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) @@ -859,6 +1040,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -868,7 +1050,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -880,6 +1064,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -889,7 +1074,9 @@ public function getAnchorYOffset() /** * 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) @@ -901,6 +1088,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -910,7 +1098,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -922,6 +1112,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -931,7 +1122,9 @@ public function getConditionalParentLabel() /** * 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) @@ -943,6 +1136,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -952,7 +1146,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -964,6 +1160,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -973,7 +1170,9 @@ public function getConditionalParentValue() /** * 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) @@ -985,6 +1184,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -994,7 +1194,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1006,6 +1208,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1015,7 +1218,9 @@ public function getCustomTabId() /** * 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) @@ -1027,6 +1232,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1036,7 +1242,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1048,6 +1256,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1057,7 +1266,9 @@ public function getDocumentId() /** * 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) @@ -1069,6 +1280,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1078,7 +1290,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1090,6 +1304,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1099,7 +1314,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1111,6 +1328,7 @@ public function setErrorDetails($error_details) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1120,7 +1338,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1132,6 +1352,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1141,7 +1362,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1153,6 +1376,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1162,7 +1386,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1174,6 +1400,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1183,7 +1410,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1195,6 +1424,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1204,7 +1434,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1216,6 +1448,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1225,7 +1458,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1237,6 +1472,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1246,7 +1482,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1258,6 +1496,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1267,7 +1506,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1279,6 +1520,7 @@ public function setHeightMetadata($height_metadata) /** * Gets locked + * * @return string */ public function getLocked() @@ -1288,7 +1530,9 @@ public function getLocked() /** * 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) @@ -1300,6 +1544,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1309,7 +1554,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1321,6 +1568,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1330,7 +1578,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1342,6 +1592,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1351,7 +1602,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1363,6 +1616,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1372,7 +1626,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1384,6 +1640,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1393,7 +1650,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1405,6 +1664,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1414,7 +1674,9 @@ public function getRecipientId() /** * 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) @@ -1426,6 +1688,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1435,7 +1698,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1447,6 +1712,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1456,7 +1722,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1468,6 +1736,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1477,7 +1746,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1489,6 +1760,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -1498,7 +1770,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -1510,6 +1784,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -1519,7 +1794,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -1531,6 +1808,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1540,7 +1818,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1552,6 +1832,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1561,7 +1842,9 @@ public function getStatus() /** * 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) @@ -1573,6 +1856,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1582,7 +1866,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1594,6 +1880,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1603,7 +1890,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1615,6 +1904,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1624,7 +1914,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1636,6 +1928,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1645,7 +1938,9 @@ public function getTabId() /** * 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) @@ -1657,6 +1952,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1666,7 +1962,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1678,6 +1976,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1687,7 +1986,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1699,6 +2000,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1708,7 +2010,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -1720,6 +2024,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -1729,7 +2034,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -1741,6 +2048,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -1750,7 +2058,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -1762,6 +2072,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1771,7 +2082,9 @@ public function getTemplateLocked() /** * 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) @@ -1783,6 +2096,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -1792,7 +2106,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -1804,6 +2120,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1813,7 +2130,9 @@ public function getTemplateRequired() /** * 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) @@ -1825,6 +2144,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -1834,7 +2154,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -1846,6 +2168,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1855,7 +2178,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1867,6 +2192,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -1876,7 +2202,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -1888,6 +2216,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -1897,7 +2226,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1909,6 +2240,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -1918,7 +2250,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -1930,6 +2264,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1939,7 +2274,9 @@ public function getXPosition() /** * 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) @@ -1951,6 +2288,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -1960,7 +2298,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -1972,6 +2312,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1981,7 +2322,9 @@ public function getYPosition() /** * 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) @@ -1993,6 +2336,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2002,7 +2346,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2013,7 +2359,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2023,7 +2371,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2033,8 +2383,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2048,7 +2400,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2058,16 +2412,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Notary.php b/src/Model/Notary.php index 53000519..9cc98009 100644 --- a/src/Model/Notary.php +++ b/src/Model/Notary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Notary Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Notary implements ArrayAccess +class Notary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class Notary implements ArrayAccess 'user_info' => '\DocuSign\eSign\Model\UserInformation' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'created_date' => null, + 'enabled' => null, + 'searchable' => null, + 'user_info' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'user_info' => 'userInfo' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'user_info' => 'setUserInfo' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'user_info' => 'getUserInfo' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets created_date + * * @return string */ public function getCreatedDate() @@ -171,7 +234,9 @@ public function getCreatedDate() /** * Sets created_date + * * @param string $created_date + * * @return $this */ public function setCreatedDate($created_date) @@ -183,6 +248,7 @@ public function setCreatedDate($created_date) /** * Gets enabled + * * @return string */ public function getEnabled() @@ -192,7 +258,9 @@ public function getEnabled() /** * Sets enabled + * * @param string $enabled + * * @return $this */ public function setEnabled($enabled) @@ -204,6 +272,7 @@ public function setEnabled($enabled) /** * Gets searchable + * * @return string */ public function getSearchable() @@ -213,7 +282,9 @@ public function getSearchable() /** * Sets searchable + * * @param string $searchable + * * @return $this */ public function setSearchable($searchable) @@ -225,6 +296,7 @@ public function setSearchable($searchable) /** * Gets user_info + * * @return \DocuSign\eSign\Model\UserInformation */ public function getUserInfo() @@ -234,7 +306,9 @@ public function getUserInfo() /** * Sets user_info - * @param \DocuSign\eSign\Model\UserInformation $user_info + * + * @param \DocuSign\eSign\Model\UserInformation $user_info user_info + * * @return $this */ public function setUserInfo($user_info) @@ -245,7 +319,9 @@ public function setUserInfo($user_info) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotaryHost.php b/src/Model/NotaryHost.php index 78d74f3a..d15fdaa9 100644 --- a/src/Model/NotaryHost.php +++ b/src/Model/NotaryHost.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotaryHost Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotaryHost implements ArrayAccess +class NotaryHost implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notaryHost'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -80,6 +83,7 @@ class NotaryHost implements ArrayAccess 'id_check_configuration_name' => 'string', 'id_check_configuration_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'locked_recipient_phone_auth_editable' => 'string', 'locked_recipient_sms_editable' => 'string', @@ -118,13 +122,101 @@ class NotaryHost implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'allow_system_override_for_locked_recipient' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email' => null, + 'email_metadata' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'host_recipient_id' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'name_metadata' => null, + 'note' => null, + 'note_metadata' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_id_metadata' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'tabs' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -154,6 +246,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_configuration_name_metadata' => 'idCheckConfigurationNameMetadata', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'locked_recipient_phone_auth_editable' => 'lockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable' => 'lockedRecipientSmsEditable', @@ -192,9 +285,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -224,6 +317,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'setIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'locked_recipient_phone_auth_editable' => 'setLockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable' => 'setLockedRecipientSmsEditable', @@ -262,9 +356,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -294,6 +388,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'getIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'locked_recipient_phone_auth_editable' => 'getLockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable' => 'getLockedRecipientSmsEditable', @@ -332,34 +427,63 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -389,6 +513,7 @@ public function __construct(array $data = null) $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_configuration_name_metadata'] = isset($data['id_check_configuration_name_metadata']) ? $data['id_check_configuration_name_metadata'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['identity_verification'] = isset($data['identity_verification']) ? $data['identity_verification'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; $this->container['locked_recipient_phone_auth_editable'] = isset($data['locked_recipient_phone_auth_editable']) ? $data['locked_recipient_phone_auth_editable'] : null; $this->container['locked_recipient_sms_editable'] = isset($data['locked_recipient_sms_editable']) ? $data['locked_recipient_sms_editable'] : null; @@ -428,30 +553,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -461,7 +588,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -473,6 +602,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -482,7 +612,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -494,6 +626,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -503,7 +636,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -515,6 +650,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -524,7 +660,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -536,6 +674,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -545,7 +684,9 @@ public function getClientUserId() /** * 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) @@ -557,6 +698,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -566,7 +708,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -578,6 +722,7 @@ public function setCompletedCount($completed_count) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -587,7 +732,9 @@ public function getCustomFields() /** * 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) @@ -599,6 +746,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -608,7 +756,9 @@ public function getDeclinedDateTime() /** * 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) @@ -620,6 +770,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -629,7 +780,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -641,6 +794,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -650,7 +804,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -662,6 +818,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -671,7 +828,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -683,6 +842,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -692,7 +852,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -704,6 +866,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -713,7 +876,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -725,6 +890,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -734,7 +900,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -746,6 +914,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -755,7 +924,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -767,6 +938,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -776,7 +948,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -788,6 +962,7 @@ public function setEmail($email) /** * Gets email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailMetadata() @@ -797,7 +972,9 @@ public function getEmailMetadata() /** * Sets email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata email_metadata + * * @return $this */ public function setEmailMetadata($email_metadata) @@ -809,6 +986,7 @@ public function setEmailMetadata($email_metadata) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -818,7 +996,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -830,6 +1010,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -839,7 +1020,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -851,6 +1034,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -860,7 +1044,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -872,6 +1058,7 @@ public function setErrorDetails($error_details) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -881,7 +1068,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -893,6 +1082,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -902,7 +1092,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -914,6 +1106,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets host_recipient_id + * * @return string */ public function getHostRecipientId() @@ -923,7 +1116,9 @@ public function getHostRecipientId() /** * Sets host_recipient_id + * * @param string $host_recipient_id + * * @return $this */ public function setHostRecipientId($host_recipient_id) @@ -935,6 +1130,7 @@ public function setHostRecipientId($host_recipient_id) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -944,7 +1140,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -956,6 +1154,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -965,7 +1164,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -977,6 +1178,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -986,7 +1188,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -996,8 +1200,33 @@ public function setIdCheckInformationInput($id_check_information_input) return $this; } + /** + * Gets identity_verification + * + * @return \DocuSign\eSign\Model\RecipientIdentityVerification + */ + public function getIdentityVerification() + { + return $this->container['identity_verification']; + } + + /** + * Sets identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * + * @return $this + */ + public function setIdentityVerification($identity_verification) + { + $this->container['identity_verification'] = $identity_verification; + + return $this; + } + /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1007,7 +1236,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -1019,6 +1250,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -1028,7 +1260,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -1040,6 +1274,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -1049,7 +1284,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -1061,6 +1298,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -1070,7 +1308,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1082,6 +1322,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1091,7 +1332,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1103,6 +1346,7 @@ public function setNameMetadata($name_metadata) /** * Gets note + * * @return string */ public function getNote() @@ -1112,7 +1356,9 @@ public function getNote() /** * 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) @@ -1124,6 +1370,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1133,7 +1380,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1145,6 +1394,7 @@ public function setNoteMetadata($note_metadata) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1154,7 +1404,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1166,6 +1418,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1175,7 +1428,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1187,6 +1442,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1196,7 +1452,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1208,6 +1466,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1217,7 +1476,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1229,6 +1490,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1238,7 +1500,9 @@ public function getRecipientId() /** * 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) @@ -1250,6 +1514,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1259,7 +1524,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1271,6 +1538,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1280,7 +1548,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1292,6 +1562,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1301,7 +1572,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1313,6 +1586,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1322,7 +1596,9 @@ public function getRequireIdLookup() /** * 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) @@ -1334,6 +1610,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1343,7 +1620,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1355,6 +1634,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1364,7 +1644,9 @@ public function getRoleName() /** * 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) @@ -1376,6 +1658,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1385,7 +1668,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -1397,6 +1682,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -1406,7 +1692,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -1418,6 +1706,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1427,7 +1716,9 @@ public function getSentDateTime() /** * 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) @@ -1439,6 +1730,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1448,7 +1740,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -1460,6 +1754,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1469,7 +1764,9 @@ public function getSigningGroupId() /** * 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) @@ -1481,6 +1778,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSigningGroupIdMetadata() @@ -1490,7 +1788,9 @@ public function getSigningGroupIdMetadata() /** * Sets signing_group_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata signing_group_id_metadata + * * @return $this */ public function setSigningGroupIdMetadata($signing_group_id_metadata) @@ -1502,6 +1802,7 @@ public function setSigningGroupIdMetadata($signing_group_id_metadata) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1511,7 +1812,9 @@ public function getSigningGroupName() /** * 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) @@ -1523,6 +1826,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1532,7 +1836,9 @@ public function getSigningGroupUsers() /** * 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) @@ -1544,6 +1850,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1553,7 +1860,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -1565,6 +1874,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1574,7 +1884,9 @@ public function getSocialAuthentications() /** * 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) @@ -1586,6 +1898,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1595,7 +1908,9 @@ public function getStatus() /** * 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) @@ -1607,6 +1922,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -1616,7 +1932,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -1628,6 +1946,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -1637,7 +1956,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -1649,6 +1970,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -1658,7 +1980,9 @@ public function getTabs() /** * Sets tabs - * @param \DocuSign\eSign\Model\Tabs $tabs + * + * @param \DocuSign\eSign\Model\Tabs $tabs tabs + * * @return $this */ public function setTabs($tabs) @@ -1670,6 +1994,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1679,7 +2004,9 @@ public function getTemplateLocked() /** * 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) @@ -1691,6 +2018,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1700,7 +2028,9 @@ public function getTemplateRequired() /** * 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) @@ -1712,6 +2042,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1721,7 +2052,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1733,6 +2066,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1742,7 +2076,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1753,7 +2089,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1763,7 +2101,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1773,8 +2113,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1788,7 +2130,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1798,16 +2142,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotaryJournal.php b/src/Model/NotaryJournal.php index 95957546..7888057a 100644 --- a/src/Model/NotaryJournal.php +++ b/src/Model/NotaryJournal.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotaryJournal Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotaryJournal implements ArrayAccess +class NotaryJournal implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notaryJournal'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class NotaryJournal implements ArrayAccess 'signer_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'created_date' => null, + 'document_name' => null, + 'jurisdiction' => null, + 'notary_journal_id' => null, + 'notary_journal_meta_data' => null, + 'signer_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'signer_name' => 'signerName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'signer_name' => 'setSignerName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'signer_name' => 'getSignerName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets created_date + * * @return string */ public function getCreatedDate() @@ -181,7 +246,9 @@ public function getCreatedDate() /** * Sets created_date + * * @param string $created_date + * * @return $this */ public function setCreatedDate($created_date) @@ -193,6 +260,7 @@ public function setCreatedDate($created_date) /** * Gets document_name + * * @return string */ public function getDocumentName() @@ -202,7 +270,9 @@ public function getDocumentName() /** * Sets document_name + * * @param string $document_name + * * @return $this */ public function setDocumentName($document_name) @@ -214,6 +284,7 @@ public function setDocumentName($document_name) /** * Gets jurisdiction + * * @return \DocuSign\eSign\Model\Jurisdiction */ public function getJurisdiction() @@ -223,7 +294,9 @@ public function getJurisdiction() /** * Sets jurisdiction - * @param \DocuSign\eSign\Model\Jurisdiction $jurisdiction + * + * @param \DocuSign\eSign\Model\Jurisdiction $jurisdiction jurisdiction + * * @return $this */ public function setJurisdiction($jurisdiction) @@ -235,6 +308,7 @@ public function setJurisdiction($jurisdiction) /** * Gets notary_journal_id + * * @return string */ public function getNotaryJournalId() @@ -244,7 +318,9 @@ public function getNotaryJournalId() /** * Sets notary_journal_id + * * @param string $notary_journal_id + * * @return $this */ public function setNotaryJournalId($notary_journal_id) @@ -256,6 +332,7 @@ public function setNotaryJournalId($notary_journal_id) /** * Gets notary_journal_meta_data + * * @return \DocuSign\eSign\Model\NotaryJournalMetaData */ public function getNotaryJournalMetaData() @@ -265,7 +342,9 @@ public function getNotaryJournalMetaData() /** * Sets notary_journal_meta_data - * @param \DocuSign\eSign\Model\NotaryJournalMetaData $notary_journal_meta_data + * + * @param \DocuSign\eSign\Model\NotaryJournalMetaData $notary_journal_meta_data notary_journal_meta_data + * * @return $this */ public function setNotaryJournalMetaData($notary_journal_meta_data) @@ -277,6 +356,7 @@ public function setNotaryJournalMetaData($notary_journal_meta_data) /** * Gets signer_name + * * @return string */ public function getSignerName() @@ -286,7 +366,9 @@ public function getSignerName() /** * Sets signer_name + * * @param string $signer_name + * * @return $this */ public function setSignerName($signer_name) @@ -297,7 +379,9 @@ public function setSignerName($signer_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotaryJournalCredibleWitness.php b/src/Model/NotaryJournalCredibleWitness.php index 89f0726c..852f8902 100644 --- a/src/Model/NotaryJournalCredibleWitness.php +++ b/src/Model/NotaryJournalCredibleWitness.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotaryJournalCredibleWitness Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotaryJournalCredibleWitness implements ArrayAccess +class NotaryJournalCredibleWitness implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notaryJournalCredibleWitness'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class NotaryJournalCredibleWitness implements ArrayAccess 'signature_image' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address' => null, + 'name' => null, + 'signature_image' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'signature_image' => 'signatureImage' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'signature_image' => 'setSignatureImage' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'signature_image' => 'getSignatureImage' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address + * * @return string */ public function getAddress() @@ -166,7 +228,9 @@ public function getAddress() /** * Sets address + * * @param string $address + * * @return $this */ public function setAddress($address) @@ -178,6 +242,7 @@ public function setAddress($address) /** * Gets name + * * @return string */ public function getName() @@ -187,7 +252,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -199,6 +266,7 @@ public function setName($name) /** * Gets signature_image + * * @return string */ public function getSignatureImage() @@ -208,7 +276,9 @@ public function getSignatureImage() /** * Sets signature_image + * * @param string $signature_image + * * @return $this */ public function setSignatureImage($signature_image) @@ -219,7 +289,9 @@ public function setSignatureImage($signature_image) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotaryJournalList.php b/src/Model/NotaryJournalList.php index d87e5b8b..061f3d7d 100644 --- a/src/Model/NotaryJournalList.php +++ b/src/Model/NotaryJournalList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotaryJournalList Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotaryJournalList implements ArrayAccess +class NotaryJournalList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notaryJournalList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class NotaryJournalList implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'next_uri' => null, + 'notary_journals' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -207,7 +276,9 @@ public function getNextUri() /** * 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) @@ -219,6 +290,7 @@ public function setNextUri($next_uri) /** * Gets notary_journals + * * @return \DocuSign\eSign\Model\NotaryJournal[] */ public function getNotaryJournals() @@ -228,7 +300,9 @@ public function getNotaryJournals() /** * Sets notary_journals + * * @param \DocuSign\eSign\Model\NotaryJournal[] $notary_journals + * * @return $this */ public function setNotaryJournals($notary_journals) @@ -240,6 +314,7 @@ public function setNotaryJournals($notary_journals) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotaryJournalMetaData.php b/src/Model/NotaryJournalMetaData.php index 8e869874..12d77ec9 100644 --- a/src/Model/NotaryJournalMetaData.php +++ b/src/Model/NotaryJournalMetaData.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotaryJournalMetaData Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotaryJournalMetaData implements ArrayAccess +class NotaryJournalMetaData implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notaryJournalMetaData'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class NotaryJournalMetaData implements ArrayAccess 'signer_id_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'comment' => null, + 'credible_witnesses' => null, + 'signature_image' => null, + 'signer_id_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'signer_id_type' => 'signerIdType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'signer_id_type' => 'setSignerIdType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'signer_id_type' => 'getSignerIdType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets comment + * * @return string */ public function getComment() @@ -171,7 +234,9 @@ public function getComment() /** * Sets comment + * * @param string $comment + * * @return $this */ public function setComment($comment) @@ -183,6 +248,7 @@ public function setComment($comment) /** * Gets credible_witnesses + * * @return \DocuSign\eSign\Model\NotaryJournalCredibleWitness[] */ public function getCredibleWitnesses() @@ -192,7 +258,9 @@ public function getCredibleWitnesses() /** * Sets credible_witnesses + * * @param \DocuSign\eSign\Model\NotaryJournalCredibleWitness[] $credible_witnesses + * * @return $this */ public function setCredibleWitnesses($credible_witnesses) @@ -204,6 +272,7 @@ public function setCredibleWitnesses($credible_witnesses) /** * Gets signature_image + * * @return string */ public function getSignatureImage() @@ -213,7 +282,9 @@ public function getSignatureImage() /** * Sets signature_image + * * @param string $signature_image + * * @return $this */ public function setSignatureImage($signature_image) @@ -225,6 +296,7 @@ public function setSignatureImage($signature_image) /** * Gets signer_id_type + * * @return string */ public function getSignerIdType() @@ -234,7 +306,9 @@ public function getSignerIdType() /** * Sets signer_id_type + * * @param string $signer_id_type + * * @return $this */ public function setSignerIdType($signer_id_type) @@ -245,7 +319,9 @@ public function setSignerIdType($signer_id_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotaryJurisdiction.php b/src/Model/NotaryJurisdiction.php index cf7dd46c..44131937 100644 --- a/src/Model/NotaryJurisdiction.php +++ b/src/Model/NotaryJurisdiction.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotaryJurisdiction Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotaryJurisdiction implements ArrayAccess +class NotaryJurisdiction implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notaryJurisdiction'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class NotaryJurisdiction implements ArrayAccess 'seal_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'commission_expiration' => null, + 'commission_id' => null, + 'county' => null, + 'error_details' => null, + 'jurisdiction' => null, + 'registered_name' => null, + 'seal_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'seal_type' => 'sealType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'seal_type' => 'setSealType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'seal_type' => 'getSealType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets commission_expiration + * * @return string */ public function getCommissionExpiration() @@ -186,7 +252,9 @@ public function getCommissionExpiration() /** * Sets commission_expiration + * * @param string $commission_expiration + * * @return $this */ public function setCommissionExpiration($commission_expiration) @@ -198,6 +266,7 @@ public function setCommissionExpiration($commission_expiration) /** * Gets commission_id + * * @return string */ public function getCommissionId() @@ -207,7 +276,9 @@ public function getCommissionId() /** * Sets commission_id + * * @param string $commission_id + * * @return $this */ public function setCommissionId($commission_id) @@ -219,6 +290,7 @@ public function setCommissionId($commission_id) /** * Gets county + * * @return string */ public function getCounty() @@ -228,7 +300,9 @@ public function getCounty() /** * Sets county + * * @param string $county + * * @return $this */ public function setCounty($county) @@ -240,6 +314,7 @@ public function setCounty($county) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -249,7 +324,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -261,6 +338,7 @@ public function setErrorDetails($error_details) /** * Gets jurisdiction + * * @return \DocuSign\eSign\Model\Jurisdiction */ public function getJurisdiction() @@ -270,7 +348,9 @@ public function getJurisdiction() /** * Sets jurisdiction - * @param \DocuSign\eSign\Model\Jurisdiction $jurisdiction + * + * @param \DocuSign\eSign\Model\Jurisdiction $jurisdiction jurisdiction + * * @return $this */ public function setJurisdiction($jurisdiction) @@ -282,6 +362,7 @@ public function setJurisdiction($jurisdiction) /** * Gets registered_name + * * @return string */ public function getRegisteredName() @@ -291,7 +372,9 @@ public function getRegisteredName() /** * Sets registered_name + * * @param string $registered_name + * * @return $this */ public function setRegisteredName($registered_name) @@ -303,6 +386,7 @@ public function setRegisteredName($registered_name) /** * Gets seal_type + * * @return string */ public function getSealType() @@ -312,7 +396,9 @@ public function getSealType() /** * Sets seal_type + * * @param string $seal_type + * * @return $this */ public function setSealType($seal_type) @@ -323,7 +409,9 @@ public function setSealType($seal_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotaryJurisdictionList.php b/src/Model/NotaryJurisdictionList.php index 8e4b3c80..52f1a2fc 100644 --- a/src/Model/NotaryJurisdictionList.php +++ b/src/Model/NotaryJurisdictionList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotaryJurisdictionList Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotaryJurisdictionList implements ArrayAccess +class NotaryJurisdictionList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notaryJurisdictionList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class NotaryJurisdictionList implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'next_uri' => null, + 'notary_jurisdictions' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -207,7 +276,9 @@ public function getNextUri() /** * 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) @@ -219,6 +290,7 @@ public function setNextUri($next_uri) /** * Gets notary_jurisdictions + * * @return \DocuSign\eSign\Model\NotaryJurisdiction[] */ public function getNotaryJurisdictions() @@ -228,7 +300,9 @@ public function getNotaryJurisdictions() /** * Sets notary_jurisdictions + * * @param \DocuSign\eSign\Model\NotaryJurisdiction[] $notary_jurisdictions + * * @return $this */ public function setNotaryJurisdictions($notary_jurisdictions) @@ -240,6 +314,7 @@ public function setNotaryJurisdictions($notary_jurisdictions) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotaryResult.php b/src/Model/NotaryResult.php index 64b0c52b..3bdffaa3 100644 --- a/src/Model/NotaryResult.php +++ b/src/Model/NotaryResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotaryResult Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotaryResult implements ArrayAccess +class NotaryResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notaryResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class NotaryResult implements ArrayAccess 'notary' => '\DocuSign\eSign\Model\Notary' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'jurisdictions' => null, + 'notary' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'notary' => 'notary' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'notary' => 'setNotary' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'notary' => 'getNotary' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets jurisdictions + * * @return \DocuSign\eSign\Model\Jurisdiction[] */ public function getJurisdictions() @@ -161,7 +222,9 @@ public function getJurisdictions() /** * Sets jurisdictions + * * @param \DocuSign\eSign\Model\Jurisdiction[] $jurisdictions + * * @return $this */ public function setJurisdictions($jurisdictions) @@ -173,6 +236,7 @@ public function setJurisdictions($jurisdictions) /** * Gets notary + * * @return \DocuSign\eSign\Model\Notary */ public function getNotary() @@ -182,7 +246,9 @@ public function getNotary() /** * Sets notary - * @param \DocuSign\eSign\Model\Notary $notary + * + * @param \DocuSign\eSign\Model\Notary $notary notary + * * @return $this */ public function setNotary($notary) @@ -193,7 +259,9 @@ public function setNotary($notary) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Note.php b/src/Model/Note.php index 37061913..76426a74 100644 --- a/src/Model/Note.php +++ b/src/Model/Note.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Note Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Note implements ArrayAccess +class Note implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'note'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -145,13 +148,127 @@ class Note implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -246,9 +363,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -343,9 +460,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -440,34 +557,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -563,30 +709,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -596,7 +744,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -608,6 +758,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -617,7 +768,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -629,6 +782,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -638,7 +792,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -650,6 +806,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -659,7 +816,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -671,6 +830,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -680,7 +840,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -692,6 +854,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -701,7 +864,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -713,6 +878,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -722,7 +888,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -734,6 +902,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -743,7 +912,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -755,6 +926,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -764,7 +936,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -776,6 +950,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -785,7 +960,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -797,6 +974,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -806,7 +984,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -818,6 +998,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -827,7 +1008,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -839,6 +1022,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -848,7 +1032,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -860,6 +1046,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -869,7 +1056,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -881,6 +1070,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -890,7 +1080,9 @@ public function getAnchorUnits() /** * 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) @@ -902,6 +1094,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -911,7 +1104,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -923,6 +1118,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -932,7 +1128,9 @@ public function getAnchorXOffset() /** * 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) @@ -944,6 +1142,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -953,7 +1152,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -965,6 +1166,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -974,7 +1176,9 @@ public function getAnchorYOffset() /** * 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) @@ -986,6 +1190,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -995,7 +1200,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1007,6 +1214,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1016,7 +1224,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1028,6 +1238,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1037,7 +1248,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1049,6 +1262,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1058,7 +1272,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1070,6 +1286,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1079,7 +1296,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1091,6 +1310,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1100,7 +1320,9 @@ public function getConditionalParentValue() /** * 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) @@ -1112,6 +1334,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1121,7 +1344,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1133,6 +1358,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1142,7 +1368,9 @@ public function getCustomTabId() /** * 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) @@ -1154,6 +1382,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1163,7 +1392,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1175,6 +1406,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1184,7 +1416,9 @@ public function getDocumentId() /** * 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) @@ -1196,6 +1430,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1205,7 +1440,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1217,6 +1454,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1226,7 +1464,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1238,6 +1478,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1247,7 +1488,9 @@ public function getFont() /** * 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) @@ -1259,6 +1502,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1268,7 +1512,9 @@ public function getFontColor() /** * 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) @@ -1280,6 +1526,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1289,7 +1536,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1301,6 +1550,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1310,7 +1560,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1322,6 +1574,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1331,7 +1584,9 @@ public function getFontSize() /** * 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) @@ -1343,6 +1598,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1352,7 +1608,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1364,6 +1622,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1373,7 +1632,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1385,6 +1646,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1394,7 +1656,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1406,6 +1670,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1415,7 +1680,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1427,6 +1694,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1436,7 +1704,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1448,6 +1718,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1457,7 +1728,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1469,6 +1742,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1478,7 +1752,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1490,6 +1766,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1499,7 +1776,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1511,6 +1790,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1520,7 +1800,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1532,6 +1814,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1541,7 +1824,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1553,6 +1838,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1562,7 +1848,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1574,6 +1862,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1583,7 +1872,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1595,6 +1886,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1604,7 +1896,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1616,6 +1910,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1625,7 +1920,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1637,6 +1934,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1646,7 +1944,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -1658,6 +1958,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1667,7 +1968,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1679,6 +1982,7 @@ public function setNameMetadata($name_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1688,7 +1992,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1700,6 +2006,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1709,7 +2016,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1721,6 +2030,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1730,7 +2040,9 @@ public function getRecipientId() /** * 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) @@ -1742,6 +2054,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1751,7 +2064,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1763,6 +2078,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1772,7 +2088,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1784,6 +2102,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1793,7 +2112,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1805,6 +2126,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -1814,7 +2136,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1826,6 +2150,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -1835,7 +2160,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -1847,6 +2174,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1856,7 +2184,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1868,6 +2198,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1877,7 +2208,9 @@ public function getStatus() /** * 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) @@ -1889,6 +2222,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1898,7 +2232,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1910,6 +2246,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1919,7 +2256,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1931,6 +2270,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1940,7 +2280,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1952,6 +2294,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1961,7 +2304,9 @@ public function getTabId() /** * 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) @@ -1973,6 +2318,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1982,7 +2328,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1994,6 +2342,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2003,7 +2352,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2015,6 +2366,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2024,7 +2376,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2036,6 +2390,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2045,7 +2400,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2057,6 +2414,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2066,7 +2424,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2078,6 +2438,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2087,7 +2448,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2099,6 +2462,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2108,7 +2472,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2120,6 +2486,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2129,7 +2496,9 @@ public function getTemplateLocked() /** * 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) @@ -2141,6 +2510,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2150,7 +2520,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2162,6 +2534,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2171,7 +2544,9 @@ public function getTemplateRequired() /** * 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) @@ -2183,6 +2558,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2192,7 +2568,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2204,6 +2582,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2213,7 +2592,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2225,6 +2606,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2234,7 +2616,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2246,6 +2630,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2255,7 +2640,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2267,6 +2654,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2276,7 +2664,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2288,6 +2678,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2297,7 +2688,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2309,6 +2702,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2318,7 +2712,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2330,6 +2726,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2339,7 +2736,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2351,6 +2750,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2360,7 +2760,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2372,6 +2774,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2381,7 +2784,9 @@ public function getXPosition() /** * 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) @@ -2393,6 +2798,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2402,7 +2808,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2414,6 +2822,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2423,7 +2832,9 @@ public function getYPosition() /** * 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) @@ -2435,6 +2846,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2444,7 +2856,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2455,7 +2869,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2465,7 +2881,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2475,8 +2893,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2490,7 +2910,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2500,16 +2922,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Notification.php b/src/Model/Notification.php index 19a7dd6e..ccafe74c 100644 --- a/src/Model/Notification.php +++ b/src/Model/Notification.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Notification Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Notification implements ArrayAccess +class Notification implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notification'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class Notification implements ArrayAccess 'use_account_defaults' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'expirations' => null, + 'reminders' => null, + 'use_account_defaults' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'use_account_defaults' => 'useAccountDefaults' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'use_account_defaults' => 'setUseAccountDefaults' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'use_account_defaults' => 'getUseAccountDefaults' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets expirations + * * @return \DocuSign\eSign\Model\Expirations */ public function getExpirations() @@ -167,7 +229,9 @@ public function getExpirations() /** * Sets expirations - * @param \DocuSign\eSign\Model\Expirations $expirations + * + * @param \DocuSign\eSign\Model\Expirations $expirations expirations + * * @return $this */ public function setExpirations($expirations) @@ -179,6 +243,7 @@ public function setExpirations($expirations) /** * Gets reminders + * * @return \DocuSign\eSign\Model\Reminders */ public function getReminders() @@ -188,7 +253,9 @@ public function getReminders() /** * Sets reminders - * @param \DocuSign\eSign\Model\Reminders $reminders + * + * @param \DocuSign\eSign\Model\Reminders $reminders reminders + * * @return $this */ public function setReminders($reminders) @@ -200,6 +267,7 @@ public function setReminders($reminders) /** * Gets use_account_defaults + * * @return string */ public function getUseAccountDefaults() @@ -209,7 +277,9 @@ public function getUseAccountDefaults() /** * Sets use_account_defaults + * * @param string $use_account_defaults When set to **true**, the account default notification settings are used for the envelope. + * * @return $this */ public function setUseAccountDefaults($use_account_defaults) @@ -220,7 +290,9 @@ public function setUseAccountDefaults($use_account_defaults) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotificationDefaultSettings.php b/src/Model/NotificationDefaultSettings.php index db314a91..148786ee 100644 --- a/src/Model/NotificationDefaultSettings.php +++ b/src/Model/NotificationDefaultSettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotificationDefaultSettings Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotificationDefaultSettings implements ArrayAccess +class NotificationDefaultSettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notificationDefaultSettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class NotificationDefaultSettings implements ArrayAccess 'signer_email_notifications' => '\DocuSign\eSign\Model\SignerEmailNotifications' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'sender_email_notifications' => null, + 'signer_email_notifications' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'signer_email_notifications' => 'signerEmailNotifications' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'signer_email_notifications' => 'setSignerEmailNotifications' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'signer_email_notifications' => 'getSignerEmailNotifications' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets sender_email_notifications + * * @return \DocuSign\eSign\Model\SenderEmailNotifications */ public function getSenderEmailNotifications() @@ -161,7 +222,9 @@ public function getSenderEmailNotifications() /** * Sets sender_email_notifications - * @param \DocuSign\eSign\Model\SenderEmailNotifications $sender_email_notifications + * + * @param \DocuSign\eSign\Model\SenderEmailNotifications $sender_email_notifications sender_email_notifications + * * @return $this */ public function setSenderEmailNotifications($sender_email_notifications) @@ -173,6 +236,7 @@ public function setSenderEmailNotifications($sender_email_notifications) /** * Gets signer_email_notifications + * * @return \DocuSign\eSign\Model\SignerEmailNotifications */ public function getSignerEmailNotifications() @@ -182,7 +246,9 @@ public function getSignerEmailNotifications() /** * Sets signer_email_notifications - * @param \DocuSign\eSign\Model\SignerEmailNotifications $signer_email_notifications + * + * @param \DocuSign\eSign\Model\SignerEmailNotifications $signer_email_notifications signer_email_notifications + * * @return $this */ public function setSignerEmailNotifications($signer_email_notifications) @@ -193,7 +259,9 @@ public function setSignerEmailNotifications($signer_email_notifications) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/NotificationDefaults.php b/src/Model/NotificationDefaults.php index 690f2dee..7902a947 100644 --- a/src/Model/NotificationDefaults.php +++ b/src/Model/NotificationDefaults.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * NotificationDefaults Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class NotificationDefaults implements ArrayAccess +class NotificationDefaults implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'notificationDefaults'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class NotificationDefaults implements ArrayAccess 'email_notifications' => '\DocuSign\eSign\Model\NotificationDefaultSettings' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'api_email_notifications' => null, + 'email_notifications' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'email_notifications' => 'emailNotifications' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'email_notifications' => 'setEmailNotifications' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'email_notifications' => 'getEmailNotifications' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets api_email_notifications + * * @return \DocuSign\eSign\Model\NotificationDefaultSettings */ public function getApiEmailNotifications() @@ -161,7 +222,9 @@ public function getApiEmailNotifications() /** * Sets api_email_notifications - * @param \DocuSign\eSign\Model\NotificationDefaultSettings $api_email_notifications + * + * @param \DocuSign\eSign\Model\NotificationDefaultSettings $api_email_notifications api_email_notifications + * * @return $this */ public function setApiEmailNotifications($api_email_notifications) @@ -173,6 +236,7 @@ public function setApiEmailNotifications($api_email_notifications) /** * Gets email_notifications + * * @return \DocuSign\eSign\Model\NotificationDefaultSettings */ public function getEmailNotifications() @@ -182,7 +246,9 @@ public function getEmailNotifications() /** * Sets email_notifications - * @param \DocuSign\eSign\Model\NotificationDefaultSettings $email_notifications + * + * @param \DocuSign\eSign\Model\NotificationDefaultSettings $email_notifications email_notifications + * * @return $this */ public function setEmailNotifications($email_notifications) @@ -193,7 +259,9 @@ public function setEmailNotifications($email_notifications) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Number.php b/src/Model/Number.php index 06df9f81..7a810d70 100644 --- a/src/Model/Number.php +++ b/src/Model/Number.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Number Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Number implements ArrayAccess +class Number implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'number'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -171,13 +174,153 @@ class Number implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conceal_value_on_document' => null, + 'conceal_value_on_document_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'disable_auto_size' => null, + 'disable_auto_size_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'formula' => null, + 'formula_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'is_payment_amount' => null, + 'is_payment_amount_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'max_length' => null, + 'max_length_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'original_value' => null, + 'original_value_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'require_all' => null, + 'require_all_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'sender_required' => null, + 'sender_required_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'validation_message' => null, + 'validation_message_metadata' => null, + 'validation_pattern' => null, + 'validation_pattern_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -298,9 +441,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -421,9 +564,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -544,34 +687,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -693,30 +865,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -726,7 +900,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -738,6 +914,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -747,7 +924,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -759,6 +938,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -768,7 +948,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -780,6 +962,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -789,7 +972,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -801,6 +986,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -810,7 +996,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -822,6 +1010,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -831,7 +1020,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -843,6 +1034,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -852,7 +1044,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -864,6 +1058,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -873,7 +1068,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -885,6 +1082,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -894,7 +1092,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -906,6 +1106,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -915,7 +1116,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -927,6 +1130,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -936,7 +1140,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -948,6 +1154,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -957,7 +1164,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -969,6 +1178,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -978,7 +1188,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -990,6 +1202,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -999,7 +1212,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -1011,6 +1226,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -1020,7 +1236,9 @@ public function getAnchorUnits() /** * 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) @@ -1032,6 +1250,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -1041,7 +1260,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -1053,6 +1274,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -1062,7 +1284,9 @@ public function getAnchorXOffset() /** * 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) @@ -1074,6 +1298,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1083,7 +1308,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1095,6 +1322,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1104,7 +1332,9 @@ public function getAnchorYOffset() /** * 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) @@ -1116,6 +1346,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1125,7 +1356,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1137,6 +1370,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1146,7 +1380,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1158,6 +1394,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1167,7 +1404,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1179,6 +1418,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -1188,7 +1428,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -1200,6 +1442,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conceal_value_on_document_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConcealValueOnDocumentMetadata() @@ -1209,7 +1452,9 @@ public function getConcealValueOnDocumentMetadata() /** * Sets conceal_value_on_document_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata conceal_value_on_document_metadata + * * @return $this */ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_metadata) @@ -1221,6 +1466,7 @@ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_met /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1230,7 +1476,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1242,6 +1490,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1251,7 +1500,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1263,6 +1514,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1272,7 +1524,9 @@ public function getConditionalParentValue() /** * 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) @@ -1284,6 +1538,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1293,7 +1548,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1305,6 +1562,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1314,7 +1572,9 @@ public function getCustomTabId() /** * 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) @@ -1326,6 +1586,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1335,7 +1596,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1347,6 +1610,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -1356,7 +1620,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -1368,6 +1634,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets disable_auto_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisableAutoSizeMetadata() @@ -1377,7 +1644,9 @@ public function getDisableAutoSizeMetadata() /** * Sets disable_auto_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata disable_auto_size_metadata + * * @return $this */ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) @@ -1389,6 +1658,7 @@ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1398,7 +1668,9 @@ public function getDocumentId() /** * 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) @@ -1410,6 +1682,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1419,7 +1692,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1431,6 +1706,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1440,7 +1716,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1452,6 +1730,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1461,7 +1740,9 @@ public function getFont() /** * 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) @@ -1473,6 +1754,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1482,7 +1764,9 @@ public function getFontColor() /** * 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) @@ -1494,6 +1778,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1503,7 +1788,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1515,6 +1802,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1524,7 +1812,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1536,6 +1826,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1545,7 +1836,9 @@ public function getFontSize() /** * 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) @@ -1557,6 +1850,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1566,7 +1860,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1578,6 +1874,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1587,7 +1884,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1599,6 +1898,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1608,7 +1908,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1620,6 +1922,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1629,7 +1932,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1641,6 +1946,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1650,7 +1956,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1662,6 +1970,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1671,7 +1980,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1683,6 +1994,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1692,7 +2004,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1704,6 +2018,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets formula + * * @return string */ public function getFormula() @@ -1713,7 +2028,9 @@ public function getFormula() /** * Sets formula + * * @param string $formula The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] + * * @return $this */ public function setFormula($formula) @@ -1725,6 +2042,7 @@ public function setFormula($formula) /** * Gets formula_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormulaMetadata() @@ -1734,7 +2052,9 @@ public function getFormulaMetadata() /** * Sets formula_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $formula_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $formula_metadata formula_metadata + * * @return $this */ public function setFormulaMetadata($formula_metadata) @@ -1746,6 +2066,7 @@ public function setFormulaMetadata($formula_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1755,7 +2076,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1767,6 +2090,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1776,7 +2100,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1788,6 +2114,7 @@ public function setHeightMetadata($height_metadata) /** * Gets is_payment_amount + * * @return string */ public function getIsPaymentAmount() @@ -1797,7 +2124,9 @@ public function getIsPaymentAmount() /** * Sets is_payment_amount + * * @param string $is_payment_amount When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. + * * @return $this */ public function setIsPaymentAmount($is_payment_amount) @@ -1809,6 +2138,7 @@ public function setIsPaymentAmount($is_payment_amount) /** * Gets is_payment_amount_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIsPaymentAmountMetadata() @@ -1818,7 +2148,9 @@ public function getIsPaymentAmountMetadata() /** * Sets is_payment_amount_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $is_payment_amount_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $is_payment_amount_metadata is_payment_amount_metadata + * * @return $this */ public function setIsPaymentAmountMetadata($is_payment_amount_metadata) @@ -1830,6 +2162,7 @@ public function setIsPaymentAmountMetadata($is_payment_amount_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1839,7 +2172,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1851,6 +2186,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1860,7 +2196,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1872,6 +2210,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1881,7 +2220,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1893,6 +2234,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1902,7 +2244,9 @@ public function getLocked() /** * 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) @@ -1914,6 +2258,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1923,7 +2268,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1935,6 +2282,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets max_length + * * @return string */ public function getMaxLength() @@ -1944,7 +2292,9 @@ public function getMaxLength() /** * Sets max_length + * * @param string $max_length An optional value that describes the maximum length of the property when the property is a string. + * * @return $this */ public function setMaxLength($max_length) @@ -1956,6 +2306,7 @@ public function setMaxLength($max_length) /** * Gets max_length_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaxLengthMetadata() @@ -1965,7 +2316,9 @@ public function getMaxLengthMetadata() /** * Sets max_length_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata max_length_metadata + * * @return $this */ public function setMaxLengthMetadata($max_length_metadata) @@ -1977,6 +2330,7 @@ public function setMaxLengthMetadata($max_length_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1986,7 +2340,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1998,6 +2354,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -2007,7 +2364,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -2019,6 +2378,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -2028,7 +2388,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -2040,6 +2402,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -2049,7 +2412,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -2061,6 +2426,7 @@ public function setNameMetadata($name_metadata) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -2070,7 +2436,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -2082,6 +2450,7 @@ public function setOriginalValue($original_value) /** * Gets original_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOriginalValueMetadata() @@ -2091,7 +2460,9 @@ public function getOriginalValueMetadata() /** * Sets original_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata original_value_metadata + * * @return $this */ public function setOriginalValueMetadata($original_value_metadata) @@ -2103,6 +2474,7 @@ public function setOriginalValueMetadata($original_value_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -2112,7 +2484,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -2124,6 +2498,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -2133,7 +2508,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -2145,6 +2522,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -2154,7 +2532,9 @@ public function getRecipientId() /** * 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) @@ -2166,6 +2546,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -2175,7 +2556,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -2187,6 +2570,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -2196,7 +2580,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -2208,6 +2594,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -2217,7 +2604,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -2229,6 +2618,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -2238,7 +2628,9 @@ public function getRequireAll() /** * 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) @@ -2250,6 +2642,7 @@ public function setRequireAll($require_all) /** * Gets require_all_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireAllMetadata() @@ -2259,7 +2652,9 @@ public function getRequireAllMetadata() /** * Sets require_all_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata require_all_metadata + * * @return $this */ public function setRequireAllMetadata($require_all_metadata) @@ -2271,6 +2666,7 @@ public function setRequireAllMetadata($require_all_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -2280,7 +2676,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -2292,6 +2690,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -2301,7 +2700,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2313,6 +2714,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -2322,7 +2724,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -2334,6 +2738,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -2343,7 +2748,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -2355,6 +2762,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -2364,7 +2772,9 @@ public function getSenderRequired() /** * 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. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + * * @return $this */ public function setSenderRequired($sender_required) @@ -2376,6 +2786,7 @@ public function setSenderRequired($sender_required) /** * Gets sender_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderRequiredMetadata() @@ -2385,7 +2796,9 @@ public function getSenderRequiredMetadata() /** * Sets sender_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata sender_required_metadata + * * @return $this */ public function setSenderRequiredMetadata($sender_required_metadata) @@ -2397,6 +2810,7 @@ public function setSenderRequiredMetadata($sender_required_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -2406,7 +2820,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -2418,6 +2834,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -2427,7 +2844,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -2439,6 +2858,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2448,7 +2868,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2460,6 +2882,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2469,7 +2892,9 @@ public function getStatus() /** * 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) @@ -2481,6 +2906,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2490,7 +2916,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2502,6 +2930,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2511,7 +2940,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2523,6 +2954,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2532,7 +2964,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2544,6 +2978,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2553,7 +2988,9 @@ public function getTabId() /** * 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) @@ -2565,6 +3002,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2574,7 +3012,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2586,6 +3026,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2595,7 +3036,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2607,6 +3050,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2616,7 +3060,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2628,6 +3074,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2637,7 +3084,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2649,6 +3098,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2658,7 +3108,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2670,6 +3122,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2679,7 +3132,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2691,6 +3146,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2700,7 +3156,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2712,6 +3170,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2721,7 +3180,9 @@ public function getTemplateLocked() /** * 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) @@ -2733,6 +3194,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2742,7 +3204,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2754,6 +3218,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2763,7 +3228,9 @@ public function getTemplateRequired() /** * 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) @@ -2775,6 +3242,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2784,7 +3252,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2796,6 +3266,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2805,7 +3276,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2817,6 +3290,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2826,7 +3300,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2838,6 +3314,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2847,7 +3324,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2859,6 +3338,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2868,7 +3348,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2880,6 +3362,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -2889,7 +3372,9 @@ public function getValidationMessage() /** * Sets validation_message + * * @param string $validation_message The message displayed if the custom tab fails input validation (either custom of embedded). + * * @return $this */ public function setValidationMessage($validation_message) @@ -2901,6 +3386,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_message_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationMessageMetadata() @@ -2910,7 +3396,9 @@ public function getValidationMessageMetadata() /** * Sets validation_message_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata validation_message_metadata + * * @return $this */ public function setValidationMessageMetadata($validation_message_metadata) @@ -2922,6 +3410,7 @@ public function setValidationMessageMetadata($validation_message_metadata) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -2931,7 +3420,9 @@ public function getValidationPattern() /** * Sets validation_pattern + * * @param string $validation_pattern A regular expression used to validate input for the tab. + * * @return $this */ public function setValidationPattern($validation_pattern) @@ -2943,6 +3434,7 @@ public function setValidationPattern($validation_pattern) /** * Gets validation_pattern_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationPatternMetadata() @@ -2952,7 +3444,9 @@ public function getValidationPatternMetadata() /** * Sets validation_pattern_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata validation_pattern_metadata + * * @return $this */ public function setValidationPatternMetadata($validation_pattern_metadata) @@ -2964,6 +3458,7 @@ public function setValidationPatternMetadata($validation_pattern_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2973,7 +3468,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2985,6 +3482,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2994,7 +3492,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -3006,6 +3506,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -3015,7 +3516,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -3027,6 +3530,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -3036,7 +3540,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -3048,6 +3554,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -3057,7 +3564,9 @@ public function getXPosition() /** * 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) @@ -3069,6 +3578,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -3078,7 +3588,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -3090,6 +3602,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -3099,7 +3612,9 @@ public function getYPosition() /** * 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) @@ -3111,6 +3626,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -3120,7 +3636,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -3131,7 +3649,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -3141,7 +3661,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -3151,8 +3673,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -3166,7 +3690,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -3176,16 +3702,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/OauthAccess.php b/src/Model/OauthAccess.php index e3201c81..ca3678a6 100644 --- a/src/Model/OauthAccess.php +++ b/src/Model/OauthAccess.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * OauthAccess Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class OauthAccess implements ArrayAccess +class OauthAccess implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'oauthAccess'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class OauthAccess implements ArrayAccess 'token_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_token' => null, + 'data' => null, + 'expires_in' => null, + 'refresh_token' => null, + 'scope' => null, + 'token_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'token_type' => 'token_type' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'token_type' => 'setTokenType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'token_type' => 'getTokenType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_token + * * @return string */ public function getAccessToken() @@ -181,7 +246,9 @@ public function getAccessToken() /** * Sets access_token + * * @param string $access_token Access token information. + * * @return $this */ public function setAccessToken($access_token) @@ -193,6 +260,7 @@ public function setAccessToken($access_token) /** * Gets data + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getData() @@ -202,7 +270,9 @@ public function getData() /** * Sets data + * * @param \DocuSign\eSign\Model\NameValue[] $data + * * @return $this */ public function setData($data) @@ -214,6 +284,7 @@ public function setData($data) /** * Gets expires_in + * * @return string */ public function getExpiresIn() @@ -223,7 +294,9 @@ public function getExpiresIn() /** * Sets expires_in + * * @param string $expires_in + * * @return $this */ public function setExpiresIn($expires_in) @@ -235,6 +308,7 @@ public function setExpiresIn($expires_in) /** * Gets refresh_token + * * @return string */ public function getRefreshToken() @@ -244,7 +318,9 @@ public function getRefreshToken() /** * Sets refresh_token + * * @param string $refresh_token + * * @return $this */ public function setRefreshToken($refresh_token) @@ -256,6 +332,7 @@ public function setRefreshToken($refresh_token) /** * Gets scope + * * @return string */ public function getScope() @@ -265,7 +342,9 @@ public function getScope() /** * Sets scope + * * @param string $scope Must be set to \"api\". + * * @return $this */ public function setScope($scope) @@ -277,6 +356,7 @@ public function setScope($scope) /** * Gets token_type + * * @return string */ public function getTokenType() @@ -286,7 +366,9 @@ public function getTokenType() /** * Sets token_type + * * @param string $token_type + * * @return $this */ public function setTokenType($token_type) @@ -297,7 +379,9 @@ public function setTokenType($token_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/OfflineAttributes.php b/src/Model/OfflineAttributes.php index 7999904e..cca3ffb5 100644 --- a/src/Model/OfflineAttributes.php +++ b/src/Model/OfflineAttributes.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * OfflineAttributes Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class OfflineAttributes implements ArrayAccess +class OfflineAttributes implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'offlineAttributes'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,44 @@ class OfflineAttributes implements ArrayAccess 'offline_signing_hash' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_esign_id' => null, + 'device_model' => null, + 'device_name' => null, + 'gps_latitude' => null, + 'gps_longitude' => null, + 'offline_signing_hash' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -81,9 +115,9 @@ public static function swaggerTypes() 'offline_signing_hash' => 'offlineSigningHash' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -95,9 +129,9 @@ public static function swaggerTypes() 'offline_signing_hash' => 'setOfflineSigningHash' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -109,34 +143,63 @@ public static function swaggerTypes() 'offline_signing_hash' => 'getOfflineSigningHash' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -149,30 +212,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_esign_id + * * @return string */ public function getAccountEsignId() @@ -182,7 +247,9 @@ public function getAccountEsignId() /** * Sets account_esign_id + * * @param string $account_esign_id A GUID identifying the account associated with the consumer disclosure + * * @return $this */ public function setAccountEsignId($account_esign_id) @@ -194,6 +261,7 @@ public function setAccountEsignId($account_esign_id) /** * Gets device_model + * * @return string */ public function getDeviceModel() @@ -203,7 +271,9 @@ public function getDeviceModel() /** * Sets device_model + * * @param string $device_model A string containing information about the model of the device used for offline signing. + * * @return $this */ public function setDeviceModel($device_model) @@ -215,6 +285,7 @@ public function setDeviceModel($device_model) /** * Gets device_name + * * @return string */ public function getDeviceName() @@ -224,7 +295,9 @@ public function getDeviceName() /** * Sets device_name + * * @param string $device_name A string containing information about the type of device used for offline signing. + * * @return $this */ public function setDeviceName($device_name) @@ -236,6 +309,7 @@ public function setDeviceName($device_name) /** * Gets gps_latitude + * * @return string */ public function getGpsLatitude() @@ -245,7 +319,9 @@ public function getGpsLatitude() /** * Sets gps_latitude + * * @param string $gps_latitude A string containing the latitude of the device location at the time of signing. + * * @return $this */ public function setGpsLatitude($gps_latitude) @@ -257,6 +333,7 @@ public function setGpsLatitude($gps_latitude) /** * Gets gps_longitude + * * @return string */ public function getGpsLongitude() @@ -266,7 +343,9 @@ public function getGpsLongitude() /** * Sets gps_longitude + * * @param string $gps_longitude A string containing the longitude of the device location at the time of signing. + * * @return $this */ public function setGpsLongitude($gps_longitude) @@ -278,6 +357,7 @@ public function setGpsLongitude($gps_longitude) /** * Gets offline_signing_hash + * * @return string */ public function getOfflineSigningHash() @@ -287,7 +367,9 @@ public function getOfflineSigningHash() /** * Sets offline_signing_hash + * * @param string $offline_signing_hash + * * @return $this */ public function setOfflineSigningHash($offline_signing_hash) @@ -298,7 +380,9 @@ public function setOfflineSigningHash($offline_signing_hash) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -308,7 +392,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -318,8 +404,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -333,7 +421,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -343,16 +433,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Page.php b/src/Model/Page.php index f47da3b9..1bde6325 100644 --- a/src/Model/Page.php +++ b/src/Model/Page.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Page Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Page implements ArrayAccess +class Page implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'page'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,46 @@ class Page implements ArrayAccess 'width' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'dpi' => null, + 'error_details' => null, + 'height' => null, + 'image_bytes' => null, + 'mime_type' => null, + 'page_id' => null, + 'sequence' => null, + 'width' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -85,9 +121,9 @@ public static function swaggerTypes() 'width' => 'width' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -101,9 +137,9 @@ public static function swaggerTypes() 'width' => 'setWidth' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -117,34 +153,63 @@ public static function swaggerTypes() 'width' => 'getWidth' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -159,30 +224,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets dpi + * * @return string */ public function getDpi() @@ -192,7 +259,9 @@ public function getDpi() /** * Sets dpi + * * @param string $dpi The number of dots per inch used for the page image. + * * @return $this */ public function setDpi($dpi) @@ -204,6 +273,7 @@ public function setDpi($dpi) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -213,7 +283,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -225,6 +297,7 @@ public function setErrorDetails($error_details) /** * Gets height + * * @return string */ public function getHeight() @@ -234,7 +307,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -246,6 +321,7 @@ public function setHeight($height) /** * Gets image_bytes + * * @return string */ public function getImageBytes() @@ -255,7 +331,9 @@ public function getImageBytes() /** * Sets image_bytes + * * @param string $image_bytes + * * @return $this */ public function setImageBytes($image_bytes) @@ -267,6 +345,7 @@ public function setImageBytes($image_bytes) /** * Gets mime_type + * * @return string */ public function getMimeType() @@ -276,7 +355,9 @@ public function getMimeType() /** * Sets mime_type + * * @param string $mime_type + * * @return $this */ public function setMimeType($mime_type) @@ -288,6 +369,7 @@ public function setMimeType($mime_type) /** * Gets page_id + * * @return string */ public function getPageId() @@ -297,7 +379,9 @@ public function getPageId() /** * Sets page_id + * * @param string $page_id + * * @return $this */ public function setPageId($page_id) @@ -309,6 +393,7 @@ public function setPageId($page_id) /** * Gets sequence + * * @return string */ public function getSequence() @@ -318,7 +403,9 @@ public function getSequence() /** * Sets sequence + * * @param string $sequence + * * @return $this */ public function setSequence($sequence) @@ -330,6 +417,7 @@ public function setSequence($sequence) /** * Gets width + * * @return string */ public function getWidth() @@ -339,7 +427,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -350,7 +440,9 @@ public function setWidth($width) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -360,7 +452,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -370,8 +464,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -385,7 +481,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -395,16 +493,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PageImages.php b/src/Model/PageImages.php index ee292fb2..fc0122c2 100644 --- a/src/Model/PageImages.php +++ b/src/Model/PageImages.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PageImages Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PageImages implements ArrayAccess +class PageImages implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'pageImages'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class PageImages implements ArrayAccess 'total_set_size' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'next_uri' => null, + 'pages' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -207,7 +276,9 @@ public function getNextUri() /** * 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) @@ -219,6 +290,7 @@ public function setNextUri($next_uri) /** * Gets pages + * * @return \DocuSign\eSign\Model\Page[] */ public function getPages() @@ -228,7 +300,9 @@ public function getPages() /** * Sets pages + * * @param \DocuSign\eSign\Model\Page[] $pages + * * @return $this */ public function setPages($pages) @@ -240,6 +314,7 @@ public function setPages($pages) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * 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) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * 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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PageRequest.php b/src/Model/PageRequest.php index 4db22daf..bc58a76b 100644 --- a/src/Model/PageRequest.php +++ b/src/Model/PageRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PageRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PageRequest implements ArrayAccess +class PageRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'pageRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class PageRequest implements ArrayAccess 'rotate' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'password' => null, + 'rotate' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'rotate' => 'rotate' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'rotate' => 'setRotate' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'rotate' => 'getRotate' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets password + * * @return string */ public function getPassword() @@ -161,7 +222,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -173,6 +236,7 @@ public function setPassword($password) /** * Gets rotate + * * @return string */ public function getRotate() @@ -182,7 +246,9 @@ public function getRotate() /** * Sets rotate + * * @param string $rotate Sets the direction the page image is rotated. The possible settings are: left or right + * * @return $this */ public function setRotate($rotate) @@ -193,7 +259,9 @@ public function setRotate($rotate) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PathExtendedElement.php b/src/Model/PathExtendedElement.php index 5eec2ec0..fe6fe2a2 100644 --- a/src/Model/PathExtendedElement.php +++ b/src/Model/PathExtendedElement.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PathExtendedElement Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PathExtendedElement implements ArrayAccess +class PathExtendedElement implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'pathExtendedElement'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class PathExtendedElement implements ArrayAccess 'type_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'name' => null, + 'type' => null, + 'type_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'type_name' => 'typeName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'type_name' => 'setTypeName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'type_name' => 'getTypeName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets name + * * @return string */ public function getName() @@ -166,7 +228,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -178,6 +242,7 @@ public function setName($name) /** * Gets type + * * @return string */ public function getType() @@ -187,7 +252,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -199,6 +266,7 @@ public function setType($type) /** * Gets type_name + * * @return string */ public function getTypeName() @@ -208,7 +276,9 @@ public function getTypeName() /** * Sets type_name + * * @param string $type_name + * * @return $this */ public function setTypeName($type_name) @@ -219,7 +289,9 @@ public function setTypeName($type_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PayPalLegacySettings.php b/src/Model/PayPalLegacySettings.php index c70ca1c8..02eb3222 100644 --- a/src/Model/PayPalLegacySettings.php +++ b/src/Model/PayPalLegacySettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PayPalLegacySettings Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PayPalLegacySettings implements ArrayAccess +class PayPalLegacySettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'payPalLegacySettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class PayPalLegacySettings implements ArrayAccess 'vendor' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'currency' => null, + 'partner' => null, + 'password' => null, + 'user_name' => null, + 'vendor' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'vendor' => 'vendor' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'vendor' => 'setVendor' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'vendor' => 'getVendor' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets currency + * * @return string */ public function getCurrency() @@ -176,7 +240,9 @@ public function getCurrency() /** * Sets currency + * * @param string $currency + * * @return $this */ public function setCurrency($currency) @@ -188,6 +254,7 @@ public function setCurrency($currency) /** * Gets partner + * * @return string */ public function getPartner() @@ -197,7 +264,9 @@ public function getPartner() /** * Sets partner + * * @param string $partner + * * @return $this */ public function setPartner($partner) @@ -209,6 +278,7 @@ public function setPartner($partner) /** * Gets password + * * @return string */ public function getPassword() @@ -218,7 +288,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -230,6 +302,7 @@ public function setPassword($password) /** * Gets user_name + * * @return string */ public function getUserName() @@ -239,7 +312,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -251,6 +326,7 @@ public function setUserName($user_name) /** * Gets vendor + * * @return string */ public function getVendor() @@ -260,7 +336,9 @@ public function getVendor() /** * Sets vendor + * * @param string $vendor + * * @return $this */ public function setVendor($vendor) @@ -271,7 +349,9 @@ public function setVendor($vendor) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PaymentDetails.php b/src/Model/PaymentDetails.php index 03f3907a..2e36938d 100644 --- a/src/Model/PaymentDetails.php +++ b/src/Model/PaymentDetails.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PaymentDetails Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PaymentDetails implements ArrayAccess +class PaymentDetails implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'paymentDetails'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -72,13 +75,54 @@ class PaymentDetails implements ArrayAccess 'total' => '\DocuSign\eSign\Model\Money' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allowed_payment_methods' => null, + 'charge_id' => null, + 'currency_code' => null, + 'currency_code_metadata' => null, + 'customer_id' => null, + 'custom_metadata' => null, + 'custom_metadata_required' => null, + 'gateway_account_id' => null, + 'gateway_account_id_metadata' => null, + 'gateway_display_name' => null, + 'gateway_name' => null, + 'line_items' => null, + 'payment_option' => null, + 'payment_source_id' => null, + 'status' => null, + 'total' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -100,9 +144,9 @@ public static function swaggerTypes() 'total' => 'total' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -124,9 +168,9 @@ public static function swaggerTypes() 'total' => 'setTotal' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -148,34 +192,63 @@ public static function swaggerTypes() 'total' => 'getTotal' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -198,30 +271,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allowed_payment_methods + * * @return string[] */ public function getAllowedPaymentMethods() @@ -231,7 +306,9 @@ public function getAllowedPaymentMethods() /** * Sets allowed_payment_methods + * * @param string[] $allowed_payment_methods + * * @return $this */ public function setAllowedPaymentMethods($allowed_payment_methods) @@ -243,6 +320,7 @@ public function setAllowedPaymentMethods($allowed_payment_methods) /** * Gets charge_id + * * @return string */ public function getChargeId() @@ -252,7 +330,9 @@ public function getChargeId() /** * Sets charge_id + * * @param string $charge_id + * * @return $this */ public function setChargeId($charge_id) @@ -264,6 +344,7 @@ public function setChargeId($charge_id) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -273,7 +354,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code + * * @return $this */ public function setCurrencyCode($currency_code) @@ -285,6 +368,7 @@ public function setCurrencyCode($currency_code) /** * Gets currency_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCurrencyCodeMetadata() @@ -294,7 +378,9 @@ public function getCurrencyCodeMetadata() /** * Sets currency_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $currency_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $currency_code_metadata currency_code_metadata + * * @return $this */ public function setCurrencyCodeMetadata($currency_code_metadata) @@ -306,6 +392,7 @@ public function setCurrencyCodeMetadata($currency_code_metadata) /** * Gets customer_id + * * @return string */ public function getCustomerId() @@ -315,7 +402,9 @@ public function getCustomerId() /** * Sets customer_id + * * @param string $customer_id + * * @return $this */ public function setCustomerId($customer_id) @@ -327,6 +416,7 @@ public function setCustomerId($customer_id) /** * Gets custom_metadata + * * @return string */ public function getCustomMetadata() @@ -336,7 +426,9 @@ public function getCustomMetadata() /** * Sets custom_metadata + * * @param string $custom_metadata + * * @return $this */ public function setCustomMetadata($custom_metadata) @@ -348,6 +440,7 @@ public function setCustomMetadata($custom_metadata) /** * Gets custom_metadata_required + * * @return bool */ public function getCustomMetadataRequired() @@ -357,7 +450,9 @@ public function getCustomMetadataRequired() /** * Sets custom_metadata_required + * * @param bool $custom_metadata_required + * * @return $this */ public function setCustomMetadataRequired($custom_metadata_required) @@ -369,6 +464,7 @@ public function setCustomMetadataRequired($custom_metadata_required) /** * Gets gateway_account_id + * * @return string */ public function getGatewayAccountId() @@ -378,7 +474,9 @@ public function getGatewayAccountId() /** * Sets gateway_account_id + * * @param string $gateway_account_id + * * @return $this */ public function setGatewayAccountId($gateway_account_id) @@ -390,6 +488,7 @@ public function setGatewayAccountId($gateway_account_id) /** * Gets gateway_account_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getGatewayAccountIdMetadata() @@ -399,7 +498,9 @@ public function getGatewayAccountIdMetadata() /** * Sets gateway_account_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $gateway_account_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $gateway_account_id_metadata gateway_account_id_metadata + * * @return $this */ public function setGatewayAccountIdMetadata($gateway_account_id_metadata) @@ -411,6 +512,7 @@ public function setGatewayAccountIdMetadata($gateway_account_id_metadata) /** * Gets gateway_display_name + * * @return string */ public function getGatewayDisplayName() @@ -420,7 +522,9 @@ public function getGatewayDisplayName() /** * Sets gateway_display_name + * * @param string $gateway_display_name + * * @return $this */ public function setGatewayDisplayName($gateway_display_name) @@ -432,6 +536,7 @@ public function setGatewayDisplayName($gateway_display_name) /** * Gets gateway_name + * * @return string */ public function getGatewayName() @@ -441,7 +546,9 @@ public function getGatewayName() /** * Sets gateway_name + * * @param string $gateway_name + * * @return $this */ public function setGatewayName($gateway_name) @@ -453,6 +560,7 @@ public function setGatewayName($gateway_name) /** * Gets line_items + * * @return \DocuSign\eSign\Model\PaymentLineItem[] */ public function getLineItems() @@ -462,7 +570,9 @@ public function getLineItems() /** * Sets line_items + * * @param \DocuSign\eSign\Model\PaymentLineItem[] $line_items + * * @return $this */ public function setLineItems($line_items) @@ -474,6 +584,7 @@ public function setLineItems($line_items) /** * Gets payment_option + * * @return string */ public function getPaymentOption() @@ -483,7 +594,9 @@ public function getPaymentOption() /** * Sets payment_option + * * @param string $payment_option + * * @return $this */ public function setPaymentOption($payment_option) @@ -495,6 +608,7 @@ public function setPaymentOption($payment_option) /** * Gets payment_source_id + * * @return string */ public function getPaymentSourceId() @@ -504,7 +618,9 @@ public function getPaymentSourceId() /** * Sets payment_source_id + * * @param string $payment_source_id + * * @return $this */ public function setPaymentSourceId($payment_source_id) @@ -516,6 +632,7 @@ public function setPaymentSourceId($payment_source_id) /** * Gets status + * * @return string */ public function getStatus() @@ -525,7 +642,9 @@ public function getStatus() /** * 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) @@ -537,6 +656,7 @@ public function setStatus($status) /** * Gets total + * * @return \DocuSign\eSign\Model\Money */ public function getTotal() @@ -546,7 +666,9 @@ public function getTotal() /** * Sets total - * @param \DocuSign\eSign\Model\Money $total + * + * @param \DocuSign\eSign\Model\Money $total total + * * @return $this */ public function setTotal($total) @@ -557,7 +679,9 @@ public function setTotal($total) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -567,7 +691,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -577,8 +703,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -592,7 +720,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -602,16 +732,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PaymentGatewayAccount.php b/src/Model/PaymentGatewayAccount.php index af98b367..86cf35b5 100644 --- a/src/Model/PaymentGatewayAccount.php +++ b/src/Model/PaymentGatewayAccount.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PaymentGatewayAccount Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PaymentGatewayAccount implements ArrayAccess +class PaymentGatewayAccount implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'paymentGatewayAccount'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,16 +69,56 @@ class PaymentGatewayAccount implements ArrayAccess 'pay_pal_legacy_settings' => '\DocuSign\eSign\Model\PayPalLegacySettings', 'supported_currencies' => 'string[]', 'supported_payment_methods' => 'string[]', - 'supported_payment_methods_with_options' => '\DocuSign\eSign\Model\PaymentMethodWithOptions[]' + 'supported_payment_methods_with_options' => '\DocuSign\eSign\Model\PaymentMethodWithOptions[]', + 'zero_decimal_currencies' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_custom_metadata' => null, + 'config' => null, + 'display_name' => null, + 'is_enabled' => null, + 'is_legacy' => null, + 'last_modified' => null, + 'payment_gateway' => null, + 'payment_gateway_account_id' => null, + 'payment_gateway_display_name' => null, + 'pay_pal_legacy_settings' => null, + 'supported_currencies' => null, + 'supported_payment_methods' => null, + 'supported_payment_methods_with_options' => null, + 'zero_decimal_currencies' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -91,12 +134,13 @@ public static function swaggerTypes() 'pay_pal_legacy_settings' => 'payPalLegacySettings', 'supported_currencies' => 'supportedCurrencies', 'supported_payment_methods' => 'supportedPaymentMethods', - 'supported_payment_methods_with_options' => 'supportedPaymentMethodsWithOptions' + 'supported_payment_methods_with_options' => 'supportedPaymentMethodsWithOptions', + 'zero_decimal_currencies' => 'zeroDecimalCurrencies' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,12 +156,13 @@ public static function swaggerTypes() 'pay_pal_legacy_settings' => 'setPayPalLegacySettings', 'supported_currencies' => 'setSupportedCurrencies', 'supported_payment_methods' => 'setSupportedPaymentMethods', - 'supported_payment_methods_with_options' => 'setSupportedPaymentMethodsWithOptions' + 'supported_payment_methods_with_options' => 'setSupportedPaymentMethodsWithOptions', + 'zero_decimal_currencies' => 'setZeroDecimalCurrencies' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -133,37 +178,67 @@ public static function swaggerTypes() 'pay_pal_legacy_settings' => 'getPayPalLegacySettings', 'supported_currencies' => 'getSupportedCurrencies', 'supported_payment_methods' => 'getSupportedPaymentMethods', - 'supported_payment_methods_with_options' => 'getSupportedPaymentMethodsWithOptions' + 'supported_payment_methods_with_options' => 'getSupportedPaymentMethodsWithOptions', + 'zero_decimal_currencies' => 'getZeroDecimalCurrencies' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -180,33 +255,36 @@ public function __construct(array $data = null) $this->container['supported_currencies'] = isset($data['supported_currencies']) ? $data['supported_currencies'] : null; $this->container['supported_payment_methods'] = isset($data['supported_payment_methods']) ? $data['supported_payment_methods'] : null; $this->container['supported_payment_methods_with_options'] = isset($data['supported_payment_methods_with_options']) ? $data['supported_payment_methods_with_options'] : null; + $this->container['zero_decimal_currencies'] = isset($data['zero_decimal_currencies']) ? $data['zero_decimal_currencies'] : null; } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allow_custom_metadata + * * @return bool */ public function getAllowCustomMetadata() @@ -216,7 +294,9 @@ public function getAllowCustomMetadata() /** * Sets allow_custom_metadata + * * @param bool $allow_custom_metadata + * * @return $this */ public function setAllowCustomMetadata($allow_custom_metadata) @@ -228,6 +308,7 @@ public function setAllowCustomMetadata($allow_custom_metadata) /** * Gets config + * * @return \DocuSign\eSign\Model\PaymentGatewayAccountSetting */ public function getConfig() @@ -237,7 +318,9 @@ public function getConfig() /** * Sets config - * @param \DocuSign\eSign\Model\PaymentGatewayAccountSetting $config + * + * @param \DocuSign\eSign\Model\PaymentGatewayAccountSetting $config config + * * @return $this */ public function setConfig($config) @@ -249,6 +332,7 @@ public function setConfig($config) /** * Gets display_name + * * @return string */ public function getDisplayName() @@ -258,7 +342,9 @@ public function getDisplayName() /** * Sets display_name + * * @param string $display_name + * * @return $this */ public function setDisplayName($display_name) @@ -270,6 +356,7 @@ public function setDisplayName($display_name) /** * Gets is_enabled + * * @return string */ public function getIsEnabled() @@ -279,7 +366,9 @@ public function getIsEnabled() /** * Sets is_enabled + * * @param string $is_enabled + * * @return $this */ public function setIsEnabled($is_enabled) @@ -291,6 +380,7 @@ public function setIsEnabled($is_enabled) /** * Gets is_legacy + * * @return string */ public function getIsLegacy() @@ -300,7 +390,9 @@ public function getIsLegacy() /** * Sets is_legacy + * * @param string $is_legacy + * * @return $this */ public function setIsLegacy($is_legacy) @@ -312,6 +404,7 @@ public function setIsLegacy($is_legacy) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -321,7 +414,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified + * * @return $this */ public function setLastModified($last_modified) @@ -333,6 +428,7 @@ public function setLastModified($last_modified) /** * Gets payment_gateway + * * @return string */ public function getPaymentGateway() @@ -342,7 +438,9 @@ public function getPaymentGateway() /** * Sets payment_gateway + * * @param string $payment_gateway + * * @return $this */ public function setPaymentGateway($payment_gateway) @@ -354,6 +452,7 @@ public function setPaymentGateway($payment_gateway) /** * Gets payment_gateway_account_id + * * @return string */ public function getPaymentGatewayAccountId() @@ -363,7 +462,9 @@ public function getPaymentGatewayAccountId() /** * Sets payment_gateway_account_id + * * @param string $payment_gateway_account_id + * * @return $this */ public function setPaymentGatewayAccountId($payment_gateway_account_id) @@ -375,6 +476,7 @@ public function setPaymentGatewayAccountId($payment_gateway_account_id) /** * Gets payment_gateway_display_name + * * @return string */ public function getPaymentGatewayDisplayName() @@ -384,7 +486,9 @@ public function getPaymentGatewayDisplayName() /** * Sets payment_gateway_display_name + * * @param string $payment_gateway_display_name + * * @return $this */ public function setPaymentGatewayDisplayName($payment_gateway_display_name) @@ -396,6 +500,7 @@ public function setPaymentGatewayDisplayName($payment_gateway_display_name) /** * Gets pay_pal_legacy_settings + * * @return \DocuSign\eSign\Model\PayPalLegacySettings */ public function getPayPalLegacySettings() @@ -405,7 +510,9 @@ public function getPayPalLegacySettings() /** * Sets pay_pal_legacy_settings - * @param \DocuSign\eSign\Model\PayPalLegacySettings $pay_pal_legacy_settings + * + * @param \DocuSign\eSign\Model\PayPalLegacySettings $pay_pal_legacy_settings pay_pal_legacy_settings + * * @return $this */ public function setPayPalLegacySettings($pay_pal_legacy_settings) @@ -417,6 +524,7 @@ public function setPayPalLegacySettings($pay_pal_legacy_settings) /** * Gets supported_currencies + * * @return string[] */ public function getSupportedCurrencies() @@ -426,7 +534,9 @@ public function getSupportedCurrencies() /** * Sets supported_currencies + * * @param string[] $supported_currencies + * * @return $this */ public function setSupportedCurrencies($supported_currencies) @@ -438,6 +548,7 @@ public function setSupportedCurrencies($supported_currencies) /** * Gets supported_payment_methods + * * @return string[] */ public function getSupportedPaymentMethods() @@ -447,7 +558,9 @@ public function getSupportedPaymentMethods() /** * Sets supported_payment_methods + * * @param string[] $supported_payment_methods + * * @return $this */ public function setSupportedPaymentMethods($supported_payment_methods) @@ -459,6 +572,7 @@ public function setSupportedPaymentMethods($supported_payment_methods) /** * Gets supported_payment_methods_with_options + * * @return \DocuSign\eSign\Model\PaymentMethodWithOptions[] */ public function getSupportedPaymentMethodsWithOptions() @@ -468,7 +582,9 @@ public function getSupportedPaymentMethodsWithOptions() /** * Sets supported_payment_methods_with_options + * * @param \DocuSign\eSign\Model\PaymentMethodWithOptions[] $supported_payment_methods_with_options + * * @return $this */ public function setSupportedPaymentMethodsWithOptions($supported_payment_methods_with_options) @@ -477,9 +593,35 @@ public function setSupportedPaymentMethodsWithOptions($supported_payment_methods return $this; } + + /** + * Gets zero_decimal_currencies + * + * @return string[] + */ + public function getZeroDecimalCurrencies() + { + return $this->container['zero_decimal_currencies']; + } + + /** + * Sets zero_decimal_currencies + * + * @param string[] $zero_decimal_currencies + * + * @return $this + */ + public function setZeroDecimalCurrencies($zero_decimal_currencies) + { + $this->container['zero_decimal_currencies'] = $zero_decimal_currencies; + + return $this; + } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -489,7 +631,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -499,8 +643,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -514,7 +660,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -524,16 +672,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PaymentGatewayAccountSetting.php b/src/Model/PaymentGatewayAccountSetting.php index 9d494fb6..c05a2c3e 100644 --- a/src/Model/PaymentGatewayAccountSetting.php +++ b/src/Model/PaymentGatewayAccountSetting.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PaymentGatewayAccountSetting Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PaymentGatewayAccountSetting implements ArrayAccess +class PaymentGatewayAccountSetting implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'paymentGatewayAccountSetting'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class PaymentGatewayAccountSetting implements ArrayAccess 'merchant_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'api_fields' => null, + 'authorization_code' => null, + 'credential_status' => null, + 'merchant_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'merchant_id' => 'merchantId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'merchant_id' => 'setMerchantId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'merchant_id' => 'getMerchantId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets api_fields + * * @return string */ public function getApiFields() @@ -171,7 +234,9 @@ public function getApiFields() /** * Sets api_fields + * * @param string $api_fields + * * @return $this */ public function setApiFields($api_fields) @@ -183,6 +248,7 @@ public function setApiFields($api_fields) /** * Gets authorization_code + * * @return string */ public function getAuthorizationCode() @@ -192,7 +258,9 @@ public function getAuthorizationCode() /** * Sets authorization_code + * * @param string $authorization_code + * * @return $this */ public function setAuthorizationCode($authorization_code) @@ -204,6 +272,7 @@ public function setAuthorizationCode($authorization_code) /** * Gets credential_status + * * @return string */ public function getCredentialStatus() @@ -213,7 +282,9 @@ public function getCredentialStatus() /** * Sets credential_status + * * @param string $credential_status + * * @return $this */ public function setCredentialStatus($credential_status) @@ -225,6 +296,7 @@ public function setCredentialStatus($credential_status) /** * Gets merchant_id + * * @return string */ public function getMerchantId() @@ -234,7 +306,9 @@ public function getMerchantId() /** * Sets merchant_id + * * @param string $merchant_id + * * @return $this */ public function setMerchantId($merchant_id) @@ -245,7 +319,9 @@ public function setMerchantId($merchant_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PaymentGatewayAccountsInfo.php b/src/Model/PaymentGatewayAccountsInfo.php index c2973248..c4d20b1c 100644 --- a/src/Model/PaymentGatewayAccountsInfo.php +++ b/src/Model/PaymentGatewayAccountsInfo.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PaymentGatewayAccountsInfo Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PaymentGatewayAccountsInfo implements ArrayAccess +class PaymentGatewayAccountsInfo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'paymentGatewayAccountsInfo'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'payment_gateway_accounts' => '\DocuSign\eSign\Model\PaymentGatewayAccount[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'payment_gateway_accounts' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ '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' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets payment_gateway_accounts + * * @return \DocuSign\eSign\Model\PaymentGatewayAccount[] */ public function getPaymentGatewayAccounts() @@ -156,7 +216,9 @@ public function getPaymentGatewayAccounts() /** * Sets payment_gateway_accounts + * * @param \DocuSign\eSign\Model\PaymentGatewayAccount[] $payment_gateway_accounts + * * @return $this */ public function setPaymentGatewayAccounts($payment_gateway_accounts) @@ -167,7 +229,9 @@ public function setPaymentGatewayAccounts($payment_gateway_accounts) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PaymentLineItem.php b/src/Model/PaymentLineItem.php index 1d3cfc57..df05b69e 100644 --- a/src/Model/PaymentLineItem.php +++ b/src/Model/PaymentLineItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PaymentLineItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PaymentLineItem implements ArrayAccess +class PaymentLineItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'paymentLineItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class PaymentLineItem implements ArrayAccess 'name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'amount_reference' => null, + 'description' => null, + 'item_code' => null, + 'name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'name' => 'name' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'name' => 'setName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'name' => 'getName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets amount_reference + * * @return string */ public function getAmountReference() @@ -171,7 +234,9 @@ public function getAmountReference() /** * Sets amount_reference + * * @param string $amount_reference + * * @return $this */ public function setAmountReference($amount_reference) @@ -183,6 +248,7 @@ public function setAmountReference($amount_reference) /** * Gets description + * * @return string */ public function getDescription() @@ -192,7 +258,9 @@ public function getDescription() /** * Sets description + * * @param string $description + * * @return $this */ public function setDescription($description) @@ -204,6 +272,7 @@ public function setDescription($description) /** * Gets item_code + * * @return string */ public function getItemCode() @@ -213,7 +282,9 @@ public function getItemCode() /** * Sets item_code + * * @param string $item_code + * * @return $this */ public function setItemCode($item_code) @@ -225,6 +296,7 @@ public function setItemCode($item_code) /** * Gets name + * * @return string */ public function getName() @@ -234,7 +306,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -245,7 +319,9 @@ public function setName($name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PaymentMethodWithOptions.php b/src/Model/PaymentMethodWithOptions.php index fb7e243a..b3c2fb52 100644 --- a/src/Model/PaymentMethodWithOptions.php +++ b/src/Model/PaymentMethodWithOptions.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PaymentMethodWithOptions Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PaymentMethodWithOptions implements ArrayAccess +class PaymentMethodWithOptions implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'paymentMethodWithOptions'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class PaymentMethodWithOptions implements ArrayAccess 'type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'supported_options' => null, + 'type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'type' => 'type' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'type' => 'setType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'type' => 'getType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets supported_options + * * @return string[] */ public function getSupportedOptions() @@ -161,7 +222,9 @@ public function getSupportedOptions() /** * Sets supported_options + * * @param string[] $supported_options + * * @return $this */ public function setSupportedOptions($supported_options) @@ -173,6 +236,7 @@ public function setSupportedOptions($supported_options) /** * Gets type + * * @return string */ public function getType() @@ -182,7 +246,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -193,7 +259,9 @@ public function setType($type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PaymentProcessorInformation.php b/src/Model/PaymentProcessorInformation.php index 655f912c..bccba679 100644 --- a/src/Model/PaymentProcessorInformation.php +++ b/src/Model/PaymentProcessorInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PaymentProcessorInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PaymentProcessorInformation implements ArrayAccess +class PaymentProcessorInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'paymentProcessorInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class PaymentProcessorInformation implements ArrayAccess 'email' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address' => null, + 'billing_agreement_id' => null, + 'email' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'email' => 'email' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'email' => 'setEmail' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'email' => 'getEmail' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address + * * @return \DocuSign\eSign\Model\AddressInformation */ public function getAddress() @@ -166,7 +228,9 @@ public function getAddress() /** * Sets address - * @param \DocuSign\eSign\Model\AddressInformation $address + * + * @param \DocuSign\eSign\Model\AddressInformation $address address + * * @return $this */ public function setAddress($address) @@ -178,6 +242,7 @@ public function setAddress($address) /** * Gets billing_agreement_id + * * @return string */ public function getBillingAgreementId() @@ -187,7 +252,9 @@ public function getBillingAgreementId() /** * Sets billing_agreement_id + * * @param string $billing_agreement_id + * * @return $this */ public function setBillingAgreementId($billing_agreement_id) @@ -199,6 +266,7 @@ public function setBillingAgreementId($billing_agreement_id) /** * Gets email + * * @return string */ public function getEmail() @@ -208,7 +276,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -219,7 +289,9 @@ public function setEmail($email) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PermissionProfile.php b/src/Model/PermissionProfile.php index e341ba9b..8c1cb7b1 100644 --- a/src/Model/PermissionProfile.php +++ b/src/Model/PermissionProfile.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PermissionProfile Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PermissionProfile implements ArrayAccess +class PermissionProfile implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'permissionProfile'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class PermissionProfile implements ArrayAccess 'users' => '\DocuSign\eSign\Model\UserInformation[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'modified_by_username' => null, + 'modified_date_time' => null, + 'permission_profile_id' => null, + 'permission_profile_name' => null, + 'settings' => null, + 'user_count' => null, + 'users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'users' => 'users' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'users' => 'setUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'users' => 'getUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets modified_by_username + * * @return string */ public function getModifiedByUsername() @@ -186,7 +252,9 @@ public function getModifiedByUsername() /** * Sets modified_by_username + * * @param string $modified_by_username + * * @return $this */ public function setModifiedByUsername($modified_by_username) @@ -198,6 +266,7 @@ public function setModifiedByUsername($modified_by_username) /** * Gets modified_date_time + * * @return string */ public function getModifiedDateTime() @@ -207,7 +276,9 @@ public function getModifiedDateTime() /** * Sets modified_date_time + * * @param string $modified_date_time + * * @return $this */ public function setModifiedDateTime($modified_date_time) @@ -219,6 +290,7 @@ public function setModifiedDateTime($modified_date_time) /** * Gets permission_profile_id + * * @return string */ public function getPermissionProfileId() @@ -228,7 +300,9 @@ public function getPermissionProfileId() /** * Sets permission_profile_id + * * @param string $permission_profile_id + * * @return $this */ public function setPermissionProfileId($permission_profile_id) @@ -240,6 +314,7 @@ public function setPermissionProfileId($permission_profile_id) /** * Gets permission_profile_name + * * @return string */ public function getPermissionProfileName() @@ -249,7 +324,9 @@ public function getPermissionProfileName() /** * Sets permission_profile_name + * * @param string $permission_profile_name + * * @return $this */ public function setPermissionProfileName($permission_profile_name) @@ -261,6 +338,7 @@ public function setPermissionProfileName($permission_profile_name) /** * Gets settings + * * @return \DocuSign\eSign\Model\AccountRoleSettings */ public function getSettings() @@ -270,7 +348,9 @@ public function getSettings() /** * Sets settings - * @param \DocuSign\eSign\Model\AccountRoleSettings $settings + * + * @param \DocuSign\eSign\Model\AccountRoleSettings $settings settings + * * @return $this */ public function setSettings($settings) @@ -282,6 +362,7 @@ public function setSettings($settings) /** * Gets user_count + * * @return string */ public function getUserCount() @@ -291,7 +372,9 @@ public function getUserCount() /** * Sets user_count + * * @param string $user_count + * * @return $this */ public function setUserCount($user_count) @@ -303,6 +386,7 @@ public function setUserCount($user_count) /** * Gets users + * * @return \DocuSign\eSign\Model\UserInformation[] */ public function getUsers() @@ -312,7 +396,9 @@ public function getUsers() /** * Sets users + * * @param \DocuSign\eSign\Model\UserInformation[] $users + * * @return $this */ public function setUsers($users) @@ -323,7 +409,9 @@ public function setUsers($users) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PermissionProfileInformation.php b/src/Model/PermissionProfileInformation.php index 15955af7..e3c734bd 100644 --- a/src/Model/PermissionProfileInformation.php +++ b/src/Model/PermissionProfileInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PermissionProfileInformation Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PermissionProfileInformation implements ArrayAccess +class PermissionProfileInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'permissionProfileInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'permission_profiles' => '\DocuSign\eSign\Model\PermissionProfile[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'permission_profiles' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'permission_profiles' => 'permissionProfiles' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'permission_profiles' => 'setPermissionProfiles' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'permission_profiles' => 'getPermissionProfiles' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets permission_profiles + * * @return \DocuSign\eSign\Model\PermissionProfile[] */ public function getPermissionProfiles() @@ -156,7 +216,9 @@ public function getPermissionProfiles() /** * Sets permission_profiles + * * @param \DocuSign\eSign\Model\PermissionProfile[] $permission_profiles A complex type containing a collection of permission profiles. + * * @return $this */ public function setPermissionProfiles($permission_profiles) @@ -167,7 +229,9 @@ public function setPermissionProfiles($permission_profiles) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PlanInformation.php b/src/Model/PlanInformation.php index f11835a4..e03eccb9 100644 --- a/src/Model/PlanInformation.php +++ b/src/Model/PlanInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PlanInformation Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PlanInformation implements ArrayAccess +class PlanInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'planInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,44 @@ class PlanInformation implements ArrayAccess 'recipient_domains' => '\DocuSign\eSign\Model\RecipientDomain[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'add_ons' => null, + 'currency_code' => null, + 'free_trial_days_override' => null, + 'plan_feature_sets' => null, + 'plan_id' => null, + 'recipient_domains' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -81,9 +115,9 @@ public static function swaggerTypes() 'recipient_domains' => 'recipientDomains' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -95,9 +129,9 @@ public static function swaggerTypes() 'recipient_domains' => 'setRecipientDomains' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -109,34 +143,63 @@ public static function swaggerTypes() 'recipient_domains' => 'getRecipientDomains' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -149,30 +212,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets add_ons + * * @return \DocuSign\eSign\Model\AddOn[] */ public function getAddOns() @@ -182,7 +247,9 @@ public function getAddOns() /** * Sets add_ons + * * @param \DocuSign\eSign\Model\AddOn[] $add_ons Reserved: + * * @return $this */ public function setAddOns($add_ons) @@ -194,6 +261,7 @@ public function setAddOns($add_ons) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -203,7 +271,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code Specifies the ISO currency code for the account. + * * @return $this */ public function setCurrencyCode($currency_code) @@ -215,6 +285,7 @@ public function setCurrencyCode($currency_code) /** * Gets free_trial_days_override + * * @return string */ public function getFreeTrialDaysOverride() @@ -224,7 +295,9 @@ public function getFreeTrialDaysOverride() /** * Sets free_trial_days_override + * * @param string $free_trial_days_override Reserved for DocuSign use only. + * * @return $this */ public function setFreeTrialDaysOverride($free_trial_days_override) @@ -236,6 +309,7 @@ public function setFreeTrialDaysOverride($free_trial_days_override) /** * Gets plan_feature_sets + * * @return \DocuSign\eSign\Model\FeatureSet[] */ public function getPlanFeatureSets() @@ -245,7 +319,9 @@ public function getPlanFeatureSets() /** * Sets plan_feature_sets + * * @param \DocuSign\eSign\Model\FeatureSet[] $plan_feature_sets A complex type that sets the feature sets for the account. + * * @return $this */ public function setPlanFeatureSets($plan_feature_sets) @@ -257,6 +333,7 @@ public function setPlanFeatureSets($plan_feature_sets) /** * Gets plan_id + * * @return string */ public function getPlanId() @@ -266,7 +343,9 @@ public function getPlanId() /** * Sets plan_id + * * @param string $plan_id The DocuSign Plan ID for the account. + * * @return $this */ public function setPlanId($plan_id) @@ -278,6 +357,7 @@ public function setPlanId($plan_id) /** * Gets recipient_domains + * * @return \DocuSign\eSign\Model\RecipientDomain[] */ public function getRecipientDomains() @@ -287,7 +367,9 @@ public function getRecipientDomains() /** * Sets recipient_domains + * * @param \DocuSign\eSign\Model\RecipientDomain[] $recipient_domains + * * @return $this */ public function setRecipientDomains($recipient_domains) @@ -298,7 +380,9 @@ public function setRecipientDomains($recipient_domains) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -308,7 +392,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -318,8 +404,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -333,7 +421,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -343,16 +433,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PolyLine.php b/src/Model/PolyLine.php index e09f368c..66aca932 100644 --- a/src/Model/PolyLine.php +++ b/src/Model/PolyLine.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PolyLine Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PolyLine implements ArrayAccess +class PolyLine implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'polyLine'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class PolyLine implements ArrayAccess 'y2' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'x1' => null, + 'x2' => null, + 'y1' => null, + 'y2' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'y2' => 'y2' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'y2' => 'setY2' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'y2' => 'getY2' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets x1 + * * @return string */ public function getX1() @@ -171,7 +234,9 @@ public function getX1() /** * Sets x1 + * * @param string $x1 + * * @return $this */ public function setX1($x1) @@ -183,6 +248,7 @@ public function setX1($x1) /** * Gets x2 + * * @return string */ public function getX2() @@ -192,7 +258,9 @@ public function getX2() /** * Sets x2 + * * @param string $x2 + * * @return $this */ public function setX2($x2) @@ -204,6 +272,7 @@ public function setX2($x2) /** * Gets y1 + * * @return string */ public function getY1() @@ -213,7 +282,9 @@ public function getY1() /** * Sets y1 + * * @param string $y1 + * * @return $this */ public function setY1($y1) @@ -225,6 +296,7 @@ public function setY1($y1) /** * Gets y2 + * * @return string */ public function getY2() @@ -234,7 +306,9 @@ public function getY2() /** * Sets y2 + * * @param string $y2 + * * @return $this */ public function setY2($y2) @@ -245,7 +319,9 @@ public function setY2($y2) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PolyLineOverlay.php b/src/Model/PolyLineOverlay.php index 12dd0049..9b299b3e 100644 --- a/src/Model/PolyLineOverlay.php +++ b/src/Model/PolyLineOverlay.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PolyLineOverlay Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PolyLineOverlay implements ArrayAccess +class PolyLineOverlay implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'polyLineOverlay'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -133,13 +136,115 @@ class PolyLineOverlay implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'graphics_context' => null, + 'height' => null, + 'height_metadata' => null, + 'locked' => null, + 'locked_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'overlay_type' => null, + 'overlay_type_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'poly_lines' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -222,9 +327,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -307,9 +412,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -392,34 +497,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -503,30 +637,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -536,7 +672,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -548,6 +686,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -557,7 +696,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -569,6 +710,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -578,7 +720,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -590,6 +734,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -599,7 +744,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -611,6 +758,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -620,7 +768,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -632,6 +782,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -641,7 +792,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -653,6 +806,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -662,7 +816,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -674,6 +830,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -683,7 +840,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -695,6 +854,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -704,7 +864,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -716,6 +878,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -725,7 +888,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -737,6 +902,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -746,7 +912,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -758,6 +926,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -767,7 +936,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -779,6 +950,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -788,7 +960,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -800,6 +974,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -809,7 +984,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -821,6 +998,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -830,7 +1008,9 @@ public function getAnchorUnits() /** * 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) @@ -842,6 +1022,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -851,7 +1032,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -863,6 +1046,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -872,7 +1056,9 @@ public function getAnchorXOffset() /** * 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) @@ -884,6 +1070,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -893,7 +1080,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -905,6 +1094,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -914,7 +1104,9 @@ public function getAnchorYOffset() /** * 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) @@ -926,6 +1118,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -935,7 +1128,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -947,6 +1142,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -956,7 +1152,9 @@ public function getConditionalParentLabel() /** * 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) @@ -968,6 +1166,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -977,7 +1176,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -989,6 +1190,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -998,7 +1200,9 @@ public function getConditionalParentValue() /** * 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) @@ -1010,6 +1214,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1019,7 +1224,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1031,6 +1238,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1040,7 +1248,9 @@ public function getCustomTabId() /** * 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) @@ -1052,6 +1262,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1061,7 +1272,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1073,6 +1286,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1082,7 +1296,9 @@ public function getDocumentId() /** * 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) @@ -1094,6 +1310,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1103,7 +1320,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1115,6 +1334,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1124,7 +1344,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1136,6 +1358,7 @@ public function setErrorDetails($error_details) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1145,7 +1368,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1157,6 +1382,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1166,7 +1392,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1178,6 +1406,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1187,7 +1416,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1199,6 +1430,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1208,7 +1440,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1220,6 +1454,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1229,7 +1464,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1241,6 +1478,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1250,7 +1488,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1262,6 +1502,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets graphics_context + * * @return \DocuSign\eSign\Model\GraphicsContext */ public function getGraphicsContext() @@ -1271,7 +1512,9 @@ public function getGraphicsContext() /** * Sets graphics_context - * @param \DocuSign\eSign\Model\GraphicsContext $graphics_context + * + * @param \DocuSign\eSign\Model\GraphicsContext $graphics_context graphics_context + * * @return $this */ public function setGraphicsContext($graphics_context) @@ -1283,6 +1526,7 @@ public function setGraphicsContext($graphics_context) /** * Gets height + * * @return string */ public function getHeight() @@ -1292,7 +1536,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1304,6 +1550,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1313,7 +1560,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1325,6 +1574,7 @@ public function setHeightMetadata($height_metadata) /** * Gets locked + * * @return string */ public function getLocked() @@ -1334,7 +1584,9 @@ public function getLocked() /** * 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) @@ -1346,6 +1598,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1355,7 +1608,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1367,6 +1622,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1376,7 +1632,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1388,6 +1646,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1397,7 +1656,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1409,6 +1670,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets overlay_type + * * @return string */ public function getOverlayType() @@ -1418,7 +1680,9 @@ public function getOverlayType() /** * Sets overlay_type + * * @param string $overlay_type + * * @return $this */ public function setOverlayType($overlay_type) @@ -1430,6 +1694,7 @@ public function setOverlayType($overlay_type) /** * Gets overlay_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOverlayTypeMetadata() @@ -1439,7 +1704,9 @@ public function getOverlayTypeMetadata() /** * Sets overlay_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $overlay_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $overlay_type_metadata overlay_type_metadata + * * @return $this */ public function setOverlayTypeMetadata($overlay_type_metadata) @@ -1451,6 +1718,7 @@ public function setOverlayTypeMetadata($overlay_type_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1460,7 +1728,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1472,6 +1742,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1481,7 +1752,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1493,6 +1766,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets poly_lines + * * @return \DocuSign\eSign\Model\PolyLine[] */ public function getPolyLines() @@ -1502,7 +1776,9 @@ public function getPolyLines() /** * Sets poly_lines + * * @param \DocuSign\eSign\Model\PolyLine[] $poly_lines + * * @return $this */ public function setPolyLines($poly_lines) @@ -1514,6 +1790,7 @@ public function setPolyLines($poly_lines) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1523,7 +1800,9 @@ public function getRecipientId() /** * 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) @@ -1535,6 +1814,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1544,7 +1824,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1556,6 +1838,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1565,7 +1848,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1577,6 +1862,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1586,7 +1872,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1598,6 +1886,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -1607,7 +1896,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1619,6 +1910,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -1628,7 +1920,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -1640,6 +1934,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1649,7 +1944,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1661,6 +1958,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1670,7 +1968,9 @@ public function getStatus() /** * 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) @@ -1682,6 +1982,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1691,7 +1992,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1703,6 +2006,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1712,7 +2016,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1724,6 +2030,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1733,7 +2040,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1745,6 +2054,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1754,7 +2064,9 @@ public function getTabId() /** * 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) @@ -1766,6 +2078,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1775,7 +2088,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1787,6 +2102,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1796,7 +2112,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1808,6 +2126,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1817,7 +2136,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1829,6 +2150,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1838,7 +2160,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -1850,6 +2174,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -1859,7 +2184,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -1871,6 +2198,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -1880,7 +2208,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -1892,6 +2222,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1901,7 +2232,9 @@ public function getTemplateLocked() /** * 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) @@ -1913,6 +2246,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -1922,7 +2256,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -1934,6 +2270,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1943,7 +2280,9 @@ public function getTemplateRequired() /** * 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) @@ -1955,6 +2294,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -1964,7 +2304,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -1976,6 +2318,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1985,7 +2328,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1997,6 +2342,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2006,7 +2352,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2018,6 +2366,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2027,7 +2376,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2039,6 +2390,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2048,7 +2400,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2060,6 +2414,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2069,7 +2424,9 @@ public function getXPosition() /** * 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) @@ -2081,6 +2438,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2090,7 +2448,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2102,6 +2462,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2111,7 +2472,9 @@ public function getYPosition() /** * 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) @@ -2123,6 +2486,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2132,7 +2496,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2143,7 +2509,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2153,7 +2521,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2163,8 +2533,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2178,7 +2550,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2188,16 +2562,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PowerForm.php b/src/Model/PowerForm.php index ed7c135e..fb57a813 100644 --- a/src/Model/PowerForm.php +++ b/src/Model/PowerForm.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PowerForm Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PowerForm implements ArrayAccess +class PowerForm implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'powerForm'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -81,13 +84,63 @@ class PowerForm implements ArrayAccess 'uses_remaining' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'created_by' => null, + 'created_date_time' => null, + 'email_body' => null, + 'email_subject' => null, + 'envelopes' => null, + 'error_details' => null, + 'instructions' => null, + 'is_active' => null, + 'last_used' => null, + 'limit_use_interval' => null, + 'limit_use_interval_enabled' => null, + 'limit_use_interval_units' => null, + 'max_use_enabled' => null, + 'name' => null, + 'power_form_id' => null, + 'power_form_url' => null, + 'recipients' => null, + 'sender_name' => null, + 'sender_user_id' => null, + 'signing_mode' => null, + 'template_id' => null, + 'template_name' => null, + 'times_used' => null, + 'uri' => null, + 'uses_remaining' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -118,9 +171,9 @@ public static function swaggerTypes() 'uses_remaining' => 'usesRemaining' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -151,9 +204,9 @@ public static function swaggerTypes() 'uses_remaining' => 'setUsesRemaining' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -184,34 +237,63 @@ public static function swaggerTypes() 'uses_remaining' => 'getUsesRemaining' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -243,30 +325,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets created_by + * * @return string */ public function getCreatedBy() @@ -276,7 +360,9 @@ public function getCreatedBy() /** * Sets created_by + * * @param string $created_by + * * @return $this */ public function setCreatedBy($created_by) @@ -288,6 +374,7 @@ public function setCreatedBy($created_by) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -297,7 +384,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -309,6 +398,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets email_body + * * @return string */ public function getEmailBody() @@ -318,7 +408,9 @@ public function getEmailBody() /** * Sets email_body + * * @param string $email_body Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters. + * * @return $this */ public function setEmailBody($email_body) @@ -330,6 +422,7 @@ public function setEmailBody($email_body) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -339,7 +432,9 @@ public function getEmailSubject() /** * Sets email_subject + * * @param string $email_subject Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. + * * @return $this */ public function setEmailSubject($email_subject) @@ -351,6 +446,7 @@ public function setEmailSubject($email_subject) /** * Gets envelopes + * * @return \DocuSign\eSign\Model\Envelope[] */ public function getEnvelopes() @@ -360,7 +456,9 @@ public function getEnvelopes() /** * Sets envelopes + * * @param \DocuSign\eSign\Model\Envelope[] $envelopes + * * @return $this */ public function setEnvelopes($envelopes) @@ -372,6 +470,7 @@ public function setEnvelopes($envelopes) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -381,7 +480,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -393,6 +494,7 @@ public function setErrorDetails($error_details) /** * Gets instructions + * * @return string */ public function getInstructions() @@ -402,7 +504,9 @@ public function getInstructions() /** * Sets instructions + * * @param string $instructions + * * @return $this */ public function setInstructions($instructions) @@ -414,6 +518,7 @@ public function setInstructions($instructions) /** * Gets is_active + * * @return string */ public function getIsActive() @@ -423,7 +528,9 @@ public function getIsActive() /** * Sets is_active + * * @param string $is_active + * * @return $this */ public function setIsActive($is_active) @@ -435,6 +542,7 @@ public function setIsActive($is_active) /** * Gets last_used + * * @return string */ public function getLastUsed() @@ -444,7 +552,9 @@ public function getLastUsed() /** * Sets last_used + * * @param string $last_used + * * @return $this */ public function setLastUsed($last_used) @@ -456,6 +566,7 @@ public function setLastUsed($last_used) /** * Gets limit_use_interval + * * @return string */ public function getLimitUseInterval() @@ -465,7 +576,9 @@ public function getLimitUseInterval() /** * Sets limit_use_interval + * * @param string $limit_use_interval + * * @return $this */ public function setLimitUseInterval($limit_use_interval) @@ -477,6 +590,7 @@ public function setLimitUseInterval($limit_use_interval) /** * Gets limit_use_interval_enabled + * * @return string */ public function getLimitUseIntervalEnabled() @@ -486,7 +600,9 @@ public function getLimitUseIntervalEnabled() /** * Sets limit_use_interval_enabled + * * @param string $limit_use_interval_enabled + * * @return $this */ public function setLimitUseIntervalEnabled($limit_use_interval_enabled) @@ -498,6 +614,7 @@ public function setLimitUseIntervalEnabled($limit_use_interval_enabled) /** * Gets limit_use_interval_units + * * @return string */ public function getLimitUseIntervalUnits() @@ -507,7 +624,9 @@ public function getLimitUseIntervalUnits() /** * Sets limit_use_interval_units + * * @param string $limit_use_interval_units + * * @return $this */ public function setLimitUseIntervalUnits($limit_use_interval_units) @@ -519,6 +638,7 @@ public function setLimitUseIntervalUnits($limit_use_interval_units) /** * Gets max_use_enabled + * * @return string */ public function getMaxUseEnabled() @@ -528,7 +648,9 @@ public function getMaxUseEnabled() /** * Sets max_use_enabled + * * @param string $max_use_enabled + * * @return $this */ public function setMaxUseEnabled($max_use_enabled) @@ -540,6 +662,7 @@ public function setMaxUseEnabled($max_use_enabled) /** * Gets name + * * @return string */ public function getName() @@ -549,7 +672,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -561,6 +686,7 @@ public function setName($name) /** * Gets power_form_id + * * @return string */ public function getPowerFormId() @@ -570,7 +696,9 @@ public function getPowerFormId() /** * Sets power_form_id + * * @param string $power_form_id + * * @return $this */ public function setPowerFormId($power_form_id) @@ -582,6 +710,7 @@ public function setPowerFormId($power_form_id) /** * Gets power_form_url + * * @return string */ public function getPowerFormUrl() @@ -591,7 +720,9 @@ public function getPowerFormUrl() /** * Sets power_form_url + * * @param string $power_form_url + * * @return $this */ public function setPowerFormUrl($power_form_url) @@ -603,6 +734,7 @@ public function setPowerFormUrl($power_form_url) /** * Gets recipients + * * @return \DocuSign\eSign\Model\PowerFormRecipient[] */ public function getRecipients() @@ -612,7 +744,9 @@ public function getRecipients() /** * Sets recipients + * * @param \DocuSign\eSign\Model\PowerFormRecipient[] $recipients An array of powerform recipients. + * * @return $this */ public function setRecipients($recipients) @@ -624,6 +758,7 @@ public function setRecipients($recipients) /** * Gets sender_name + * * @return string */ public function getSenderName() @@ -633,7 +768,9 @@ public function getSenderName() /** * Sets sender_name + * * @param string $sender_name + * * @return $this */ public function setSenderName($sender_name) @@ -645,6 +782,7 @@ public function setSenderName($sender_name) /** * Gets sender_user_id + * * @return string */ public function getSenderUserId() @@ -654,7 +792,9 @@ public function getSenderUserId() /** * Sets sender_user_id + * * @param string $sender_user_id + * * @return $this */ public function setSenderUserId($sender_user_id) @@ -666,6 +806,7 @@ public function setSenderUserId($sender_user_id) /** * Gets signing_mode + * * @return string */ public function getSigningMode() @@ -675,7 +816,9 @@ public function getSigningMode() /** * Sets signing_mode + * * @param string $signing_mode + * * @return $this */ public function setSigningMode($signing_mode) @@ -687,6 +830,7 @@ public function setSigningMode($signing_mode) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -696,7 +840,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -708,6 +854,7 @@ public function setTemplateId($template_id) /** * Gets template_name + * * @return string */ public function getTemplateName() @@ -717,7 +864,9 @@ public function getTemplateName() /** * Sets template_name + * * @param string $template_name + * * @return $this */ public function setTemplateName($template_name) @@ -729,6 +878,7 @@ public function setTemplateName($template_name) /** * Gets times_used + * * @return string */ public function getTimesUsed() @@ -738,7 +888,9 @@ public function getTimesUsed() /** * Sets times_used + * * @param string $times_used + * * @return $this */ public function setTimesUsed($times_used) @@ -750,6 +902,7 @@ public function setTimesUsed($times_used) /** * Gets uri + * * @return string */ public function getUri() @@ -759,7 +912,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -771,6 +926,7 @@ public function setUri($uri) /** * Gets uses_remaining + * * @return string */ public function getUsesRemaining() @@ -780,7 +936,9 @@ public function getUsesRemaining() /** * Sets uses_remaining + * * @param string $uses_remaining + * * @return $this */ public function setUsesRemaining($uses_remaining) @@ -791,7 +949,9 @@ public function setUsesRemaining($uses_remaining) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -801,7 +961,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -811,8 +973,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -826,7 +990,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -836,16 +1002,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PowerFormFormDataEnvelope.php b/src/Model/PowerFormFormDataEnvelope.php index df0e1a7c..4380a711 100644 --- a/src/Model/PowerFormFormDataEnvelope.php +++ b/src/Model/PowerFormFormDataEnvelope.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PowerFormFormDataEnvelope Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PowerFormFormDataEnvelope implements ArrayAccess +class PowerFormFormDataEnvelope implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'powerFormFormDataEnvelope'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class PowerFormFormDataEnvelope implements ArrayAccess 'recipients' => '\DocuSign\eSign\Model\PowerFormFormDataRecipient[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_id' => null, + 'recipients' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'recipients' => 'recipients' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'recipients' => 'setRecipients' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'recipients' => 'getRecipients' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -161,7 +222,9 @@ public function getEnvelopeId() /** * 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) @@ -173,6 +236,7 @@ public function setEnvelopeId($envelope_id) /** * Gets recipients + * * @return \DocuSign\eSign\Model\PowerFormFormDataRecipient[] */ public function getRecipients() @@ -182,7 +246,9 @@ public function getRecipients() /** * Sets recipients + * * @param \DocuSign\eSign\Model\PowerFormFormDataRecipient[] $recipients An array of powerform recipients. + * * @return $this */ public function setRecipients($recipients) @@ -193,7 +259,9 @@ public function setRecipients($recipients) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PowerFormFormDataRecipient.php b/src/Model/PowerFormFormDataRecipient.php index a6928d60..1a7964c9 100644 --- a/src/Model/PowerFormFormDataRecipient.php +++ b/src/Model/PowerFormFormDataRecipient.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PowerFormFormDataRecipient Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PowerFormFormDataRecipient implements ArrayAccess +class PowerFormFormDataRecipient implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'powerFormFormDataRecipient'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class PowerFormFormDataRecipient implements ArrayAccess 'recipient_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'email' => null, + 'form_data' => null, + 'name' => null, + 'recipient_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'recipient_id' => 'recipientId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'recipient_id' => 'setRecipientId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'recipient_id' => 'getRecipientId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets email + * * @return string */ public function getEmail() @@ -171,7 +234,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -183,6 +248,7 @@ public function setEmail($email) /** * Gets form_data + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getFormData() @@ -192,7 +258,9 @@ public function getFormData() /** * Sets form_data + * * @param \DocuSign\eSign\Model\NameValue[] $form_data + * * @return $this */ public function setFormData($form_data) @@ -204,6 +272,7 @@ public function setFormData($form_data) /** * Gets name + * * @return string */ public function getName() @@ -213,7 +282,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -225,6 +296,7 @@ public function setName($name) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -234,7 +306,9 @@ public function getRecipientId() /** * 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) @@ -245,7 +319,9 @@ public function setRecipientId($recipient_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PowerFormRecipient.php b/src/Model/PowerFormRecipient.php index 81d6afc8..bbd03f25 100644 --- a/src/Model/PowerFormRecipient.php +++ b/src/Model/PowerFormRecipient.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PowerFormRecipient Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PowerFormRecipient implements ArrayAccess +class PowerFormRecipient implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'powerFormRecipient'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -69,13 +72,51 @@ class PowerFormRecipient implements ArrayAccess 'user_name_locked' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_locked' => null, + 'access_code_required' => null, + 'email' => null, + 'email_locked' => null, + 'id_check_configuration_name' => null, + 'id_check_required' => null, + 'name' => null, + 'recipient_type' => null, + 'role_name' => null, + 'routing_order' => null, + 'template_requires_id_lookup' => null, + 'user_name_locked' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -94,9 +135,9 @@ public static function swaggerTypes() 'user_name_locked' => 'userNameLocked' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -115,9 +156,9 @@ public static function swaggerTypes() 'user_name_locked' => 'setUserNameLocked' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -136,34 +177,63 @@ public static function swaggerTypes() 'user_name_locked' => 'getUserNameLocked' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -183,30 +253,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -216,7 +288,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -228,6 +302,7 @@ public function setAccessCode($access_code) /** * Gets access_code_locked + * * @return string */ public function getAccessCodeLocked() @@ -237,7 +312,9 @@ public function getAccessCodeLocked() /** * Sets access_code_locked + * * @param string $access_code_locked + * * @return $this */ public function setAccessCodeLocked($access_code_locked) @@ -249,6 +326,7 @@ public function setAccessCodeLocked($access_code_locked) /** * Gets access_code_required + * * @return string */ public function getAccessCodeRequired() @@ -258,7 +336,9 @@ public function getAccessCodeRequired() /** * Sets access_code_required + * * @param string $access_code_required + * * @return $this */ public function setAccessCodeRequired($access_code_required) @@ -270,6 +350,7 @@ public function setAccessCodeRequired($access_code_required) /** * Gets email + * * @return string */ public function getEmail() @@ -279,7 +360,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -291,6 +374,7 @@ public function setEmail($email) /** * Gets email_locked + * * @return string */ public function getEmailLocked() @@ -300,7 +384,9 @@ public function getEmailLocked() /** * Sets email_locked + * * @param string $email_locked + * * @return $this */ public function setEmailLocked($email_locked) @@ -312,6 +398,7 @@ public function setEmailLocked($email_locked) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -321,7 +408,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -333,6 +422,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_required + * * @return string */ public function getIdCheckRequired() @@ -342,7 +432,9 @@ public function getIdCheckRequired() /** * Sets id_check_required + * * @param string $id_check_required + * * @return $this */ public function setIdCheckRequired($id_check_required) @@ -354,6 +446,7 @@ public function setIdCheckRequired($id_check_required) /** * Gets name + * * @return string */ public function getName() @@ -363,7 +456,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -375,6 +470,7 @@ public function setName($name) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -384,7 +480,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -396,6 +494,7 @@ public function setRecipientType($recipient_type) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -405,7 +504,9 @@ public function getRoleName() /** * 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) @@ -417,6 +518,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -426,7 +528,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -438,6 +542,7 @@ public function setRoutingOrder($routing_order) /** * Gets template_requires_id_lookup + * * @return string */ public function getTemplateRequiresIdLookup() @@ -447,7 +552,9 @@ public function getTemplateRequiresIdLookup() /** * Sets template_requires_id_lookup + * * @param string $template_requires_id_lookup + * * @return $this */ public function setTemplateRequiresIdLookup($template_requires_id_lookup) @@ -459,6 +566,7 @@ public function setTemplateRequiresIdLookup($template_requires_id_lookup) /** * Gets user_name_locked + * * @return string */ public function getUserNameLocked() @@ -468,7 +576,9 @@ public function getUserNameLocked() /** * Sets user_name_locked + * * @param string $user_name_locked + * * @return $this */ public function setUserNameLocked($user_name_locked) @@ -479,7 +589,9 @@ public function setUserNameLocked($user_name_locked) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -489,7 +601,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -499,8 +613,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -514,7 +630,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -524,16 +642,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PowerFormSendersResponse.php b/src/Model/PowerFormSendersResponse.php index 04cd01e5..88f44817 100644 --- a/src/Model/PowerFormSendersResponse.php +++ b/src/Model/PowerFormSendersResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PowerFormSendersResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PowerFormSendersResponse implements ArrayAccess +class PowerFormSendersResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'powerFormSendersResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class PowerFormSendersResponse implements ArrayAccess 'total_set_size' => 'int' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => 'int32', + 'next_uri' => null, + 'power_form_senders' => null, + 'previous_uri' => null, + 'result_set_size' => 'int32', + 'start_position' => 'int32', + 'total_set_size' => 'int32' + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return int */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param int $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -207,7 +276,9 @@ public function getNextUri() /** * 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) @@ -219,6 +290,7 @@ public function setNextUri($next_uri) /** * Gets power_form_senders + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getPowerFormSenders() @@ -228,7 +300,9 @@ public function getPowerFormSenders() /** * Sets power_form_senders + * * @param \DocuSign\eSign\Model\UserInfo[] $power_form_senders + * * @return $this */ public function setPowerFormSenders($power_form_senders) @@ -240,6 +314,7 @@ public function setPowerFormSenders($power_form_senders) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return int */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * Sets result_set_size + * * @param int $result_set_size The number of results returned in this response. + * * @return $this */ public function setResultSetSize($result_set_size) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return int */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param int $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return int */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * Sets total_set_size + * * @param int $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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PowerFormsFormDataResponse.php b/src/Model/PowerFormsFormDataResponse.php index 523b33b0..a48d0f60 100644 --- a/src/Model/PowerFormsFormDataResponse.php +++ b/src/Model/PowerFormsFormDataResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PowerFormsFormDataResponse Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PowerFormsFormDataResponse implements ArrayAccess +class PowerFormsFormDataResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'powerFormsFormDataResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'envelopes' => '\DocuSign\eSign\Model\PowerFormFormDataEnvelope[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelopes' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'envelopes' => 'envelopes' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'envelopes' => 'setEnvelopes' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'envelopes' => 'getEnvelopes' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets envelopes + * * @return \DocuSign\eSign\Model\PowerFormFormDataEnvelope[] */ public function getEnvelopes() @@ -156,7 +216,9 @@ public function getEnvelopes() /** * Sets envelopes + * * @param \DocuSign\eSign\Model\PowerFormFormDataEnvelope[] $envelopes + * * @return $this */ public function setEnvelopes($envelopes) @@ -167,7 +229,9 @@ public function setEnvelopes($envelopes) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PowerFormsRequest.php b/src/Model/PowerFormsRequest.php index 6eb56e08..8c61e4a7 100644 --- a/src/Model/PowerFormsRequest.php +++ b/src/Model/PowerFormsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PowerFormsRequest Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PowerFormsRequest implements ArrayAccess +class PowerFormsRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'powerFormsRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'power_forms' => '\DocuSign\eSign\Model\PowerForm[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'power_forms' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'power_forms' => 'powerForms' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'power_forms' => 'setPowerForms' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'power_forms' => 'getPowerForms' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets power_forms + * * @return \DocuSign\eSign\Model\PowerForm[] */ public function getPowerForms() @@ -156,7 +216,9 @@ public function getPowerForms() /** * Sets power_forms + * * @param \DocuSign\eSign\Model\PowerForm[] $power_forms + * * @return $this */ public function setPowerForms($power_forms) @@ -167,7 +229,9 @@ public function setPowerForms($power_forms) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PowerFormsResponse.php b/src/Model/PowerFormsResponse.php index a6534b13..ef0b4dd0 100644 --- a/src/Model/PowerFormsResponse.php +++ b/src/Model/PowerFormsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PowerFormsResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PowerFormsResponse implements ArrayAccess +class PowerFormsResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'powerFormsResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class PowerFormsResponse implements ArrayAccess 'total_set_size' => 'int' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => 'int32', + 'next_uri' => null, + 'power_forms' => null, + 'previous_uri' => null, + 'result_set_size' => 'int32', + 'start_position' => 'int32', + 'total_set_size' => 'int32' + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'total_set_size' => 'totalSetSize' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'total_set_size' => 'setTotalSetSize' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'total_set_size' => 'getTotalSetSize' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return int */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param int $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -207,7 +276,9 @@ public function getNextUri() /** * 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) @@ -219,6 +290,7 @@ public function setNextUri($next_uri) /** * Gets power_forms + * * @return \DocuSign\eSign\Model\PowerForm[] */ public function getPowerForms() @@ -228,7 +300,9 @@ public function getPowerForms() /** * Sets power_forms + * * @param \DocuSign\eSign\Model\PowerForm[] $power_forms + * * @return $this */ public function setPowerForms($power_forms) @@ -240,6 +314,7 @@ public function setPowerForms($power_forms) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -249,7 +324,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -261,6 +338,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return int */ public function getResultSetSize() @@ -270,7 +348,9 @@ public function getResultSetSize() /** * Sets result_set_size + * * @param int $result_set_size The number of results returned in this response. + * * @return $this */ public function setResultSetSize($result_set_size) @@ -282,6 +362,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return int */ public function getStartPosition() @@ -291,7 +372,9 @@ public function getStartPosition() /** * Sets start_position + * * @param int $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -303,6 +386,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return int */ public function getTotalSetSize() @@ -312,7 +396,9 @@ public function getTotalSetSize() /** * Sets total_set_size + * * @param int $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) @@ -323,7 +409,9 @@ public function setTotalSetSize($total_set_size) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ProofServiceResourceToken.php b/src/Model/ProofServiceResourceToken.php index b9c11d77..dc1e349d 100644 --- a/src/Model/ProofServiceResourceToken.php +++ b/src/Model/ProofServiceResourceToken.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ProofServiceResourceToken Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ProofServiceResourceToken implements ArrayAccess +class ProofServiceResourceToken implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'proofServiceResourceToken'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'resource_token' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'resource_token' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'resource_token' => 'ResourceToken' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'resource_token' => 'setResourceToken' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'resource_token' => 'getResourceToken' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets resource_token + * * @return string */ public function getResourceToken() @@ -156,7 +216,9 @@ public function getResourceToken() /** * Sets resource_token + * * @param string $resource_token + * * @return $this */ public function setResourceToken($resource_token) @@ -167,7 +229,9 @@ public function setResourceToken($resource_token) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ProofServiceViewLink.php b/src/Model/ProofServiceViewLink.php index 2f14e311..c603e256 100644 --- a/src/Model/ProofServiceViewLink.php +++ b/src/Model/ProofServiceViewLink.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ProofServiceViewLink Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ProofServiceViewLink implements ArrayAccess +class ProofServiceViewLink implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'proofServiceViewLink'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'view_link' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'view_link' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'view_link' => 'ViewLink' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'view_link' => 'setViewLink' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'view_link' => 'getViewLink' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets view_link + * * @return string */ public function getViewLink() @@ -156,7 +216,9 @@ public function getViewLink() /** * Sets view_link + * * @param string $view_link + * * @return $this */ public function setViewLink($view_link) @@ -167,7 +229,9 @@ public function setViewLink($view_link) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PropertyMetadata.php b/src/Model/PropertyMetadata.php index 0d1b07db..884980f9 100644 --- a/src/Model/PropertyMetadata.php +++ b/src/Model/PropertyMetadata.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PropertyMetadata Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PropertyMetadata implements ArrayAccess +class PropertyMetadata implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'propertyMetadata'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class PropertyMetadata implements ArrayAccess 'rights' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'options' => null, + 'rights' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'rights' => 'rights' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'rights' => 'setRights' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'rights' => 'getRights' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets options + * * @return string[] */ public function getOptions() @@ -161,7 +222,9 @@ public function getOptions() /** * Sets options + * * @param string[] $options + * * @return $this */ public function setOptions($options) @@ -173,6 +236,7 @@ public function setOptions($options) /** * Gets rights + * * @return string */ public function getRights() @@ -182,7 +246,9 @@ public function getRights() /** * Sets rights + * * @param string $rights + * * @return $this */ public function setRights($rights) @@ -193,7 +259,9 @@ public function setRights($rights) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Province.php b/src/Model/Province.php index c314206f..1e03f3e2 100644 --- a/src/Model/Province.php +++ b/src/Model/Province.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Province Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Province implements ArrayAccess +class Province implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'province'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class Province implements ArrayAccess 'name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'iso_code' => null, + 'name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'name' => 'name' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'name' => 'setName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'name' => 'getName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets iso_code + * * @return string */ public function getIsoCode() @@ -161,7 +222,9 @@ public function getIsoCode() /** * Sets iso_code + * * @param string $iso_code + * * @return $this */ public function setIsoCode($iso_code) @@ -173,6 +236,7 @@ public function setIsoCode($iso_code) /** * Gets name + * * @return string */ public function getName() @@ -182,7 +246,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -193,7 +259,9 @@ public function setName($name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ProvisioningInformation.php b/src/Model/ProvisioningInformation.php index 4575227b..d1d5cbc9 100644 --- a/src/Model/ProvisioningInformation.php +++ b/src/Model/ProvisioningInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ProvisioningInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ProvisioningInformation implements ArrayAccess +class ProvisioningInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'provisioningInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class ProvisioningInformation implements ArrayAccess 'purchase_order_or_prom_allowed' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'default_connection_id' => null, + 'default_plan_id' => null, + 'distributor_code' => null, + 'distributor_password' => null, + 'password_rule_text' => null, + 'plan_promotion_text' => null, + 'purchase_order_or_prom_allowed' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'purchase_order_or_prom_allowed' => 'purchaseOrderOrPromAllowed' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'purchase_order_or_prom_allowed' => 'setPurchaseOrderOrPromAllowed' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'purchase_order_or_prom_allowed' => 'getPurchaseOrderOrPromAllowed' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets default_connection_id + * * @return string */ public function getDefaultConnectionId() @@ -186,7 +252,9 @@ public function getDefaultConnectionId() /** * Sets default_connection_id + * * @param string $default_connection_id + * * @return $this */ public function setDefaultConnectionId($default_connection_id) @@ -198,6 +266,7 @@ public function setDefaultConnectionId($default_connection_id) /** * Gets default_plan_id + * * @return string */ public function getDefaultPlanId() @@ -207,7 +276,9 @@ public function getDefaultPlanId() /** * Sets default_plan_id + * * @param string $default_plan_id + * * @return $this */ public function setDefaultPlanId($default_plan_id) @@ -219,6 +290,7 @@ public function setDefaultPlanId($default_plan_id) /** * Gets distributor_code + * * @return string */ public function getDistributorCode() @@ -228,7 +300,9 @@ public function getDistributorCode() /** * Sets distributor_code + * * @param string $distributor_code The code that identifies the billing plan groups and plans for the new account. + * * @return $this */ public function setDistributorCode($distributor_code) @@ -240,6 +314,7 @@ public function setDistributorCode($distributor_code) /** * Gets distributor_password + * * @return string */ public function getDistributorPassword() @@ -249,7 +324,9 @@ public function getDistributorPassword() /** * Sets distributor_password + * * @param string $distributor_password The password for the distributorCode. + * * @return $this */ public function setDistributorPassword($distributor_password) @@ -261,6 +338,7 @@ public function setDistributorPassword($distributor_password) /** * Gets password_rule_text + * * @return string */ public function getPasswordRuleText() @@ -270,7 +348,9 @@ public function getPasswordRuleText() /** * Sets password_rule_text + * * @param string $password_rule_text + * * @return $this */ public function setPasswordRuleText($password_rule_text) @@ -282,6 +362,7 @@ public function setPasswordRuleText($password_rule_text) /** * Gets plan_promotion_text + * * @return string */ public function getPlanPromotionText() @@ -291,7 +372,9 @@ public function getPlanPromotionText() /** * Sets plan_promotion_text + * * @param string $plan_promotion_text + * * @return $this */ public function setPlanPromotionText($plan_promotion_text) @@ -303,6 +386,7 @@ public function setPlanPromotionText($plan_promotion_text) /** * Gets purchase_order_or_prom_allowed + * * @return string */ public function getPurchaseOrderOrPromAllowed() @@ -312,7 +396,9 @@ public function getPurchaseOrderOrPromAllowed() /** * Sets purchase_order_or_prom_allowed + * * @param string $purchase_order_or_prom_allowed + * * @return $this */ public function setPurchaseOrderOrPromAllowed($purchase_order_or_prom_allowed) @@ -323,7 +409,9 @@ public function setPurchaseOrderOrPromAllowed($purchase_order_or_prom_allowed) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/PurchasedEnvelopesInformation.php b/src/Model/PurchasedEnvelopesInformation.php index 3c1bffa6..0062cbca 100644 --- a/src/Model/PurchasedEnvelopesInformation.php +++ b/src/Model/PurchasedEnvelopesInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * PurchasedEnvelopesInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class PurchasedEnvelopesInformation implements ArrayAccess +class PurchasedEnvelopesInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'purchasedEnvelopesInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,47 @@ class PurchasedEnvelopesInformation implements ArrayAccess 'transaction_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'amount' => null, + 'app_name' => null, + 'currency_code' => null, + 'platform' => null, + 'product_id' => null, + 'quantity' => null, + 'receipt_data' => null, + 'store_name' => null, + 'transaction_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -86,9 +123,9 @@ public static function swaggerTypes() 'transaction_id' => 'transactionId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -103,9 +140,9 @@ public static function swaggerTypes() 'transaction_id' => 'setTransactionId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -120,34 +157,63 @@ public static function swaggerTypes() 'transaction_id' => 'getTransactionId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -163,30 +229,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets amount + * * @return string */ public function getAmount() @@ -196,7 +264,9 @@ public function getAmount() /** * Sets amount + * * @param string $amount The total amount of the purchase. + * * @return $this */ public function setAmount($amount) @@ -208,6 +278,7 @@ public function setAmount($amount) /** * Gets app_name + * * @return string */ public function getAppName() @@ -217,7 +288,9 @@ public function getAppName() /** * Sets app_name + * * @param string $app_name The AppName of the client application. + * * @return $this */ public function setAppName($app_name) @@ -229,6 +302,7 @@ public function setAppName($app_name) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -238,7 +312,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code Specifies the ISO currency code of the purchase. This is based on the ISO 4217 currency code information. + * * @return $this */ public function setCurrencyCode($currency_code) @@ -250,6 +326,7 @@ public function setCurrencyCode($currency_code) /** * Gets platform + * * @return string */ public function getPlatform() @@ -259,7 +336,9 @@ public function getPlatform() /** * Sets platform + * * @param string $platform The Platform of the client application + * * @return $this */ public function setPlatform($platform) @@ -271,6 +350,7 @@ public function setPlatform($platform) /** * Gets product_id + * * @return string */ public function getProductId() @@ -280,7 +360,9 @@ public function getProductId() /** * Sets product_id + * * @param string $product_id The Product ID from the AppStore. + * * @return $this */ public function setProductId($product_id) @@ -292,6 +374,7 @@ public function setProductId($product_id) /** * Gets quantity + * * @return string */ public function getQuantity() @@ -301,7 +384,9 @@ public function getQuantity() /** * Sets quantity + * * @param string $quantity The quantity of envelopes to add to the account. + * * @return $this */ public function setQuantity($quantity) @@ -313,6 +398,7 @@ public function setQuantity($quantity) /** * Gets receipt_data + * * @return string */ public function getReceiptData() @@ -322,7 +408,9 @@ public function getReceiptData() /** * Sets receipt_data + * * @param string $receipt_data The encrypted Base64 encoded receipt data. + * * @return $this */ public function setReceiptData($receipt_data) @@ -334,6 +422,7 @@ public function setReceiptData($receipt_data) /** * Gets store_name + * * @return string */ public function getStoreName() @@ -343,7 +432,9 @@ public function getStoreName() /** * Sets store_name + * * @param string $store_name The name of the AppStore. + * * @return $this */ public function setStoreName($store_name) @@ -355,6 +446,7 @@ public function setStoreName($store_name) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -364,7 +456,9 @@ public function getTransactionId() /** * Sets transaction_id + * * @param string $transaction_id Specifies the Transaction ID from the AppStore. + * * @return $this */ public function setTransactionId($transaction_id) @@ -375,7 +469,9 @@ public function setTransactionId($transaction_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -385,7 +481,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -395,8 +493,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -410,7 +510,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -420,16 +522,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Radio.php b/src/Model/Radio.php index 06925916..1d4f43c1 100644 --- a/src/Model/Radio.php +++ b/src/Model/Radio.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Radio Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Radio implements ArrayAccess +class Radio implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'radio'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -109,13 +112,91 @@ class Radio implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locked' => null, + 'locked_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'selected' => null, + 'selected_metadata' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -174,9 +255,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -235,9 +316,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -296,34 +377,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -383,30 +493,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -416,7 +528,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -428,6 +542,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -437,7 +552,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -449,6 +566,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -458,7 +576,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -470,6 +590,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -479,7 +600,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -491,6 +614,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -500,7 +624,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -512,6 +638,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -521,7 +648,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -533,6 +662,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -542,7 +672,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -554,6 +686,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -563,7 +696,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -575,6 +710,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -584,7 +720,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -596,6 +734,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -605,7 +744,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -617,6 +758,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -626,7 +768,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -638,6 +782,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -647,7 +792,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -659,6 +806,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -668,7 +816,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -680,6 +830,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -689,7 +840,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -701,6 +854,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -710,7 +864,9 @@ public function getAnchorUnits() /** * 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) @@ -722,6 +878,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -731,7 +888,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -743,6 +902,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -752,7 +912,9 @@ public function getAnchorXOffset() /** * 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) @@ -764,6 +926,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -773,7 +936,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -785,6 +950,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -794,7 +960,9 @@ public function getAnchorYOffset() /** * 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) @@ -806,6 +974,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -815,7 +984,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -827,6 +998,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -836,7 +1008,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -848,6 +1022,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -857,7 +1032,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -869,6 +1046,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -878,7 +1056,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -890,6 +1070,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -899,7 +1080,9 @@ public function getFont() /** * 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) @@ -911,6 +1094,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -920,7 +1104,9 @@ public function getFontColor() /** * 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) @@ -932,6 +1118,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -941,7 +1128,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -953,6 +1142,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -962,7 +1152,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -974,6 +1166,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -983,7 +1176,9 @@ public function getFontSize() /** * 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) @@ -995,6 +1190,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1004,7 +1200,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1016,6 +1214,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1025,7 +1224,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1037,6 +1238,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1046,7 +1248,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1058,6 +1262,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locked + * * @return string */ public function getLocked() @@ -1067,7 +1272,9 @@ public function getLocked() /** * 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) @@ -1079,6 +1286,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1088,7 +1296,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1100,6 +1310,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1109,7 +1320,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1121,6 +1334,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1130,7 +1344,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1142,6 +1358,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -1151,7 +1368,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -1163,6 +1382,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -1172,7 +1392,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -1184,6 +1406,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets selected + * * @return string */ public function getSelected() @@ -1193,7 +1416,9 @@ public function getSelected() /** * Sets selected + * * @param string $selected When set to **true**, the radio button is selected. + * * @return $this */ public function setSelected($selected) @@ -1205,6 +1430,7 @@ public function setSelected($selected) /** * Gets selected_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSelectedMetadata() @@ -1214,7 +1440,9 @@ public function getSelectedMetadata() /** * Sets selected_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $selected_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $selected_metadata selected_metadata + * * @return $this */ public function setSelectedMetadata($selected_metadata) @@ -1226,6 +1454,7 @@ public function setSelectedMetadata($selected_metadata) /** * Gets status + * * @return string */ public function getStatus() @@ -1235,7 +1464,9 @@ public function getStatus() /** * 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) @@ -1247,6 +1478,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1256,7 +1488,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1268,6 +1502,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1277,7 +1512,9 @@ public function getTabId() /** * 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) @@ -1289,6 +1526,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1298,7 +1536,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1310,6 +1550,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1319,7 +1560,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1331,6 +1574,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1340,7 +1584,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -1352,6 +1598,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1361,7 +1608,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -1373,6 +1622,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -1382,7 +1632,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -1394,6 +1646,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -1403,7 +1656,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1415,6 +1670,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -1424,7 +1680,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -1436,6 +1694,7 @@ public function setValueMetadata($value_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1445,7 +1704,9 @@ public function getXPosition() /** * 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) @@ -1457,6 +1718,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -1466,7 +1728,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -1478,6 +1742,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1487,7 +1752,9 @@ public function getYPosition() /** * 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) @@ -1499,6 +1766,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -1508,7 +1776,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -1519,7 +1789,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1529,7 +1801,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1539,8 +1813,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1554,7 +1830,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1564,16 +1842,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RadioGroup.php b/src/Model/RadioGroup.php index 12c8ec27..94484f4c 100644 --- a/src/Model/RadioGroup.php +++ b/src/Model/RadioGroup.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RadioGroup Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RadioGroup implements ArrayAccess +class RadioGroup implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'radioGroup'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -83,13 +86,65 @@ class RadioGroup implements ArrayAccess 'tooltip_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'group_name' => null, + 'group_name_metadata' => null, + 'radios' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'require_all' => null, + 'require_all_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tooltip_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -122,9 +177,9 @@ public static function swaggerTypes() 'tooltip_metadata' => 'tooltipMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -157,9 +212,9 @@ public static function swaggerTypes() 'tooltip_metadata' => 'setTooltipMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -192,34 +247,63 @@ public static function swaggerTypes() 'tooltip_metadata' => 'getTooltipMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -253,30 +337,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -286,7 +372,9 @@ public function getConditionalParentLabel() /** * 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) @@ -298,6 +386,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -307,7 +396,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -319,6 +410,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -328,7 +420,9 @@ public function getConditionalParentValue() /** * 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) @@ -340,6 +434,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -349,7 +444,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -361,6 +458,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -370,7 +468,9 @@ public function getDocumentId() /** * 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) @@ -382,6 +482,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -391,7 +492,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -403,6 +506,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets group_name + * * @return string */ public function getGroupName() @@ -412,7 +516,9 @@ public function getGroupName() /** * Sets group_name + * * @param string $group_name The name of the group. + * * @return $this */ public function setGroupName($group_name) @@ -424,6 +530,7 @@ public function setGroupName($group_name) /** * Gets group_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getGroupNameMetadata() @@ -433,7 +540,9 @@ public function getGroupNameMetadata() /** * Sets group_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $group_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $group_name_metadata group_name_metadata + * * @return $this */ public function setGroupNameMetadata($group_name_metadata) @@ -445,6 +554,7 @@ public function setGroupNameMetadata($group_name_metadata) /** * Gets radios + * * @return \DocuSign\eSign\Model\Radio[] */ public function getRadios() @@ -454,7 +564,9 @@ public function getRadios() /** * Sets radios + * * @param \DocuSign\eSign\Model\Radio[] $radios Specifies the locations and status for radio buttons that are grouped together. + * * @return $this */ public function setRadios($radios) @@ -466,6 +578,7 @@ public function setRadios($radios) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -475,7 +588,9 @@ public function getRecipientId() /** * 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) @@ -487,6 +602,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -496,7 +612,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -508,6 +626,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -517,7 +636,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -529,6 +650,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -538,7 +660,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -550,6 +674,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -559,7 +684,9 @@ public function getRequireAll() /** * 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) @@ -571,6 +698,7 @@ public function setRequireAll($require_all) /** * Gets require_all_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireAllMetadata() @@ -580,7 +708,9 @@ public function getRequireAllMetadata() /** * Sets require_all_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata require_all_metadata + * * @return $this */ public function setRequireAllMetadata($require_all_metadata) @@ -592,6 +722,7 @@ public function setRequireAllMetadata($require_all_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -601,7 +732,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -613,6 +746,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -622,7 +756,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -634,6 +770,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets shared + * * @return string */ public function getShared() @@ -643,7 +780,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -655,6 +794,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -664,7 +804,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -676,6 +818,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -685,7 +828,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -697,6 +842,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -706,7 +852,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -718,6 +866,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -727,7 +876,9 @@ public function getTemplateLocked() /** * 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) @@ -739,6 +890,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -748,7 +900,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -760,6 +914,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -769,7 +924,9 @@ public function getTemplateRequired() /** * 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) @@ -781,6 +938,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -790,7 +948,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -802,6 +962,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -811,7 +972,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -823,6 +986,7 @@ public function setTooltip($tooltip) /** * Gets tooltip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTooltipMetadata() @@ -832,7 +996,9 @@ public function getTooltipMetadata() /** * Sets tooltip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tooltip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tooltip_metadata tooltip_metadata + * * @return $this */ public function setTooltipMetadata($tooltip_metadata) @@ -843,7 +1009,9 @@ public function setTooltipMetadata($tooltip_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -853,7 +1021,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -863,8 +1033,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -878,7 +1050,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -888,16 +1062,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientAdditionalNotification.php b/src/Model/RecipientAdditionalNotification.php new file mode 100644 index 00000000..6d3bff1a --- /dev/null +++ b/src/Model/RecipientAdditionalNotification.php @@ -0,0 +1,360 @@ + '\DocuSign\eSign\Model\RecipientPhoneNumber', + 'secondary_delivery_method' => 'string', + 'secondary_delivery_method_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'phone_number' => null, + 'secondary_delivery_method' => null, + 'secondary_delivery_method_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'phone_number' => 'phoneNumber', + 'secondary_delivery_method' => 'secondaryDeliveryMethod', + 'secondary_delivery_method_metadata' => 'secondaryDeliveryMethodMetadata' + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'phone_number' => 'setPhoneNumber', + 'secondary_delivery_method' => 'setSecondaryDeliveryMethod', + 'secondary_delivery_method_metadata' => 'setSecondaryDeliveryMethodMetadata' + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'phone_number' => 'getPhoneNumber', + 'secondary_delivery_method' => 'getSecondaryDeliveryMethod', + 'secondary_delivery_method_metadata' => 'getSecondaryDeliveryMethodMetadata' + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + + + + + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->container['phone_number'] = isset($data['phone_number']) ? $data['phone_number'] : null; + $this->container['secondary_delivery_method'] = isset($data['secondary_delivery_method']) ? $data['secondary_delivery_method'] : null; + $this->container['secondary_delivery_method_metadata'] = isset($data['secondary_delivery_method_metadata']) ? $data['secondary_delivery_method_metadata'] : null; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + + /** + * Gets phone_number + * + * @return \DocuSign\eSign\Model\RecipientPhoneNumber + */ + public function getPhoneNumber() + { + return $this->container['phone_number']; + } + + /** + * Sets phone_number + * + * @param \DocuSign\eSign\Model\RecipientPhoneNumber $phone_number phone_number + * + * @return $this + */ + public function setPhoneNumber($phone_number) + { + $this->container['phone_number'] = $phone_number; + + return $this; + } + + /** + * Gets secondary_delivery_method + * + * @return string + */ + public function getSecondaryDeliveryMethod() + { + return $this->container['secondary_delivery_method']; + } + + /** + * Sets secondary_delivery_method + * + * @param string $secondary_delivery_method + * + * @return $this + */ + public function setSecondaryDeliveryMethod($secondary_delivery_method) + { + $this->container['secondary_delivery_method'] = $secondary_delivery_method; + + return $this; + } + + /** + * Gets secondary_delivery_method_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getSecondaryDeliveryMethodMetadata() + { + return $this->container['secondary_delivery_method_metadata']; + } + + /** + * Sets secondary_delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $secondary_delivery_method_metadata secondary_delivery_method_metadata + * + * @return $this + */ + public function setSecondaryDeliveryMethodMetadata($secondary_delivery_method_metadata) + { + $this->container['secondary_delivery_method_metadata'] = $secondary_delivery_method_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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); + } + + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} + diff --git a/src/Model/RecipientAttachment.php b/src/Model/RecipientAttachment.php index bef1ffd0..bdb9196e 100644 --- a/src/Model/RecipientAttachment.php +++ b/src/Model/RecipientAttachment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientAttachment Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientAttachment implements ArrayAccess +class RecipientAttachment implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientAttachment'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class RecipientAttachment implements ArrayAccess 'remote_url' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'attachment_id' => null, + 'attachment_type' => null, + 'data' => null, + 'label' => null, + 'name' => null, + 'remote_url' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'remote_url' => 'remoteUrl' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'remote_url' => 'setRemoteUrl' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'remote_url' => 'getRemoteUrl' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets attachment_id + * * @return string */ public function getAttachmentId() @@ -181,7 +246,9 @@ public function getAttachmentId() /** * Sets attachment_id + * * @param string $attachment_id + * * @return $this */ public function setAttachmentId($attachment_id) @@ -193,6 +260,7 @@ public function setAttachmentId($attachment_id) /** * Gets attachment_type + * * @return string */ public function getAttachmentType() @@ -202,7 +270,9 @@ public function getAttachmentType() /** * Sets attachment_type + * * @param string $attachment_type + * * @return $this */ public function setAttachmentType($attachment_type) @@ -214,6 +284,7 @@ public function setAttachmentType($attachment_type) /** * Gets data + * * @return string */ public function getData() @@ -223,7 +294,9 @@ public function getData() /** * Sets data + * * @param string $data + * * @return $this */ public function setData($data) @@ -235,6 +308,7 @@ public function setData($data) /** * Gets label + * * @return string */ public function getLabel() @@ -244,7 +318,9 @@ public function getLabel() /** * Sets label + * * @param string $label + * * @return $this */ public function setLabel($label) @@ -256,6 +332,7 @@ public function setLabel($label) /** * Gets name + * * @return string */ public function getName() @@ -265,7 +342,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -277,6 +356,7 @@ public function setName($name) /** * Gets remote_url + * * @return string */ public function getRemoteUrl() @@ -286,7 +366,9 @@ public function getRemoteUrl() /** * Sets remote_url + * * @param string $remote_url + * * @return $this */ public function setRemoteUrl($remote_url) @@ -297,7 +379,9 @@ public function setRemoteUrl($remote_url) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientDomain.php b/src/Model/RecipientDomain.php index 39714589..8910d6d0 100644 --- a/src/Model/RecipientDomain.php +++ b/src/Model/RecipientDomain.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientDomain Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientDomain implements ArrayAccess +class RecipientDomain implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientDomain'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class RecipientDomain implements ArrayAccess 'recipient_domain_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'active' => null, + 'domain_code' => null, + 'domain_name' => null, + 'recipient_domain_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'recipient_domain_id' => 'recipientDomainId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'recipient_domain_id' => 'setRecipientDomainId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'recipient_domain_id' => 'getRecipientDomainId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets active + * * @return string */ public function getActive() @@ -171,7 +234,9 @@ public function getActive() /** * Sets active + * * @param string $active + * * @return $this */ public function setActive($active) @@ -183,6 +248,7 @@ public function setActive($active) /** * Gets domain_code + * * @return string */ public function getDomainCode() @@ -192,7 +258,9 @@ public function getDomainCode() /** * Sets domain_code + * * @param string $domain_code + * * @return $this */ public function setDomainCode($domain_code) @@ -204,6 +272,7 @@ public function setDomainCode($domain_code) /** * Gets domain_name + * * @return string */ public function getDomainName() @@ -213,7 +282,9 @@ public function getDomainName() /** * Sets domain_name + * * @param string $domain_name + * * @return $this */ public function setDomainName($domain_name) @@ -225,6 +296,7 @@ public function setDomainName($domain_name) /** * Gets recipient_domain_id + * * @return string */ public function getRecipientDomainId() @@ -234,7 +306,9 @@ public function getRecipientDomainId() /** * Sets recipient_domain_id + * * @param string $recipient_domain_id + * * @return $this */ public function setRecipientDomainId($recipient_domain_id) @@ -245,7 +319,9 @@ public function setRecipientDomainId($recipient_domain_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientEmailNotification.php b/src/Model/RecipientEmailNotification.php index ce81c515..45e9f3aa 100644 --- a/src/Model/RecipientEmailNotification.php +++ b/src/Model/RecipientEmailNotification.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientEmailNotification Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientEmailNotification implements ArrayAccess +class RecipientEmailNotification implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientEmailNotification'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class RecipientEmailNotification implements ArrayAccess 'supported_language_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'email_body' => null, + 'email_body_metadata' => null, + 'email_subject' => null, + 'email_subject_metadata' => null, + 'supported_language' => null, + 'supported_language_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'supported_language_metadata' => 'supportedLanguageMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'supported_language_metadata' => 'setSupportedLanguageMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'supported_language_metadata' => 'getSupportedLanguageMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets email_body + * * @return string */ public function getEmailBody() @@ -181,7 +246,9 @@ public function getEmailBody() /** * Sets email_body + * * @param string $email_body Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters. + * * @return $this */ public function setEmailBody($email_body) @@ -193,6 +260,7 @@ public function setEmailBody($email_body) /** * Gets email_body_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailBodyMetadata() @@ -202,7 +270,9 @@ public function getEmailBodyMetadata() /** * Sets email_body_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_body_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_body_metadata email_body_metadata + * * @return $this */ public function setEmailBodyMetadata($email_body_metadata) @@ -214,6 +284,7 @@ public function setEmailBodyMetadata($email_body_metadata) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -223,7 +294,9 @@ public function getEmailSubject() /** * Sets email_subject + * * @param string $email_subject Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. + * * @return $this */ public function setEmailSubject($email_subject) @@ -235,6 +308,7 @@ public function setEmailSubject($email_subject) /** * Gets email_subject_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailSubjectMetadata() @@ -244,7 +318,9 @@ public function getEmailSubjectMetadata() /** * Sets email_subject_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_subject_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_subject_metadata email_subject_metadata + * * @return $this */ public function setEmailSubjectMetadata($email_subject_metadata) @@ -256,6 +332,7 @@ public function setEmailSubjectMetadata($email_subject_metadata) /** * Gets supported_language + * * @return string */ public function getSupportedLanguage() @@ -265,7 +342,9 @@ public function getSupportedLanguage() /** * Sets supported_language + * * @param string $supported_language A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bahasa Indonesia (id), Bahasa Melayu (ms) 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), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), 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). + * * @return $this */ public function setSupportedLanguage($supported_language) @@ -277,6 +356,7 @@ public function setSupportedLanguage($supported_language) /** * Gets supported_language_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSupportedLanguageMetadata() @@ -286,7 +366,9 @@ public function getSupportedLanguageMetadata() /** * Sets supported_language_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $supported_language_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $supported_language_metadata supported_language_metadata + * * @return $this */ public function setSupportedLanguageMetadata($supported_language_metadata) @@ -297,7 +379,9 @@ public function setSupportedLanguageMetadata($supported_language_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientEvent.php b/src/Model/RecipientEvent.php index 94603e7e..0a600a17 100644 --- a/src/Model/RecipientEvent.php +++ b/src/Model/RecipientEvent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientEvent Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientEvent implements ArrayAccess +class RecipientEvent implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientEvent'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class RecipientEvent implements ArrayAccess 'recipient_event_status_code' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'include_documents' => null, + 'recipient_event_status_code' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'recipient_event_status_code' => 'recipientEventStatusCode' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'recipient_event_status_code' => 'setRecipientEventStatusCode' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'recipient_event_status_code' => 'getRecipientEventStatusCode' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets include_documents + * * @return string */ public function getIncludeDocuments() @@ -161,7 +222,9 @@ public function getIncludeDocuments() /** * Sets include_documents + * * @param string $include_documents When set to **true**, the PDF documents are included in the message along with the updated XML. + * * @return $this */ public function setIncludeDocuments($include_documents) @@ -173,6 +236,7 @@ public function setIncludeDocuments($include_documents) /** * Gets recipient_event_status_code + * * @return string */ public function getRecipientEventStatusCode() @@ -182,7 +246,9 @@ public function getRecipientEventStatusCode() /** * Sets recipient_event_status_code + * * @param string $recipient_event_status_code The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. + * * @return $this */ public function setRecipientEventStatusCode($recipient_event_status_code) @@ -193,7 +259,9 @@ public function setRecipientEventStatusCode($recipient_event_status_code) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientFormData.php b/src/Model/RecipientFormData.php index 4411be66..0ad63fae 100644 --- a/src/Model/RecipientFormData.php +++ b/src/Model/RecipientFormData.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientFormData Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientFormData implements ArrayAccess +class RecipientFormData implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientFormData'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class RecipientFormData implements ArrayAccess 'signed_time' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'declined_time' => null, + 'delivered_time' => null, + 'email' => null, + 'form_data' => null, + 'name' => null, + 'recipient_id' => null, + 'sent_time' => null, + 'signed_time' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'signed_time' => 'SignedTime' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'signed_time' => 'setSignedTime' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'signed_time' => 'getSignedTime' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets declined_time + * * @return string */ public function getDeclinedTime() @@ -191,7 +258,9 @@ public function getDeclinedTime() /** * Sets declined_time + * * @param string $declined_time + * * @return $this */ public function setDeclinedTime($declined_time) @@ -203,6 +272,7 @@ public function setDeclinedTime($declined_time) /** * Gets delivered_time + * * @return string */ public function getDeliveredTime() @@ -212,7 +282,9 @@ public function getDeliveredTime() /** * Sets delivered_time + * * @param string $delivered_time + * * @return $this */ public function setDeliveredTime($delivered_time) @@ -224,6 +296,7 @@ public function setDeliveredTime($delivered_time) /** * Gets email + * * @return string */ public function getEmail() @@ -233,7 +306,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -245,6 +320,7 @@ public function setEmail($email) /** * Gets form_data + * * @return \DocuSign\eSign\Model\FormDataItem[] */ public function getFormData() @@ -254,7 +330,9 @@ public function getFormData() /** * Sets form_data + * * @param \DocuSign\eSign\Model\FormDataItem[] $form_data + * * @return $this */ public function setFormData($form_data) @@ -266,6 +344,7 @@ public function setFormData($form_data) /** * Gets name + * * @return string */ public function getName() @@ -275,7 +354,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -287,6 +368,7 @@ public function setName($name) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -296,7 +378,9 @@ public function getRecipientId() /** * 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) @@ -308,6 +392,7 @@ public function setRecipientId($recipient_id) /** * Gets sent_time + * * @return string */ public function getSentTime() @@ -317,7 +402,9 @@ public function getSentTime() /** * Sets sent_time + * * @param string $sent_time + * * @return $this */ public function setSentTime($sent_time) @@ -329,6 +416,7 @@ public function setSentTime($sent_time) /** * Gets signed_time + * * @return string */ public function getSignedTime() @@ -338,7 +426,9 @@ public function getSignedTime() /** * Sets signed_time + * * @param string $signed_time + * * @return $this */ public function setSignedTime($signed_time) @@ -349,7 +439,9 @@ public function setSignedTime($signed_time) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientIdentityInputOption.php b/src/Model/RecipientIdentityInputOption.php index 68a6eb01..842a5ada 100644 --- a/src/Model/RecipientIdentityInputOption.php +++ b/src/Model/RecipientIdentityInputOption.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientIdentityInputOption Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientIdentityInputOption implements ArrayAccess +class RecipientIdentityInputOption implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientIdentityInputOption'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class RecipientIdentityInputOption implements ArrayAccess 'value_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'name' => null, + 'phone_number_list' => null, + 'value_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'value_type' => 'valueType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'value_type' => 'setValueType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'value_type' => 'getValueType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets name + * * @return string */ public function getName() @@ -166,7 +228,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -178,6 +242,7 @@ public function setName($name) /** * Gets phone_number_list + * * @return \DocuSign\eSign\Model\RecipientIdentityPhoneNumber[] */ public function getPhoneNumberList() @@ -187,7 +252,9 @@ public function getPhoneNumberList() /** * Sets phone_number_list + * * @param \DocuSign\eSign\Model\RecipientIdentityPhoneNumber[] $phone_number_list + * * @return $this */ public function setPhoneNumberList($phone_number_list) @@ -199,6 +266,7 @@ public function setPhoneNumberList($phone_number_list) /** * Gets value_type + * * @return string */ public function getValueType() @@ -208,7 +276,9 @@ public function getValueType() /** * Sets value_type + * * @param string $value_type + * * @return $this */ public function setValueType($value_type) @@ -219,7 +289,9 @@ public function setValueType($value_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientIdentityPhoneNumber.php b/src/Model/RecipientIdentityPhoneNumber.php index f3278733..994f1d2d 100644 --- a/src/Model/RecipientIdentityPhoneNumber.php +++ b/src/Model/RecipientIdentityPhoneNumber.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientIdentityPhoneNumber Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientIdentityPhoneNumber implements ArrayAccess +class RecipientIdentityPhoneNumber implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientIdentityPhoneNumber'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class RecipientIdentityPhoneNumber implements ArrayAccess 'number' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'country_code' => null, + 'extension' => null, + 'number' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'number' => 'number' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'number' => 'setNumber' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'number' => 'getNumber' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets country_code + * * @return string */ public function getCountryCode() @@ -166,7 +228,9 @@ public function getCountryCode() /** * Sets country_code + * * @param string $country_code + * * @return $this */ public function setCountryCode($country_code) @@ -178,6 +242,7 @@ public function setCountryCode($country_code) /** * Gets extension + * * @return string */ public function getExtension() @@ -187,7 +252,9 @@ public function getExtension() /** * Sets extension + * * @param string $extension + * * @return $this */ public function setExtension($extension) @@ -199,6 +266,7 @@ public function setExtension($extension) /** * Gets number + * * @return string */ public function getNumber() @@ -208,7 +276,9 @@ public function getNumber() /** * Sets number + * * @param string $number + * * @return $this */ public function setNumber($number) @@ -219,7 +289,9 @@ public function setNumber($number) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientIdentityVerification.php b/src/Model/RecipientIdentityVerification.php index c948fc28..10a17437 100644 --- a/src/Model/RecipientIdentityVerification.php +++ b/src/Model/RecipientIdentityVerification.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientIdentityVerification Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientIdentityVerification implements ArrayAccess +class RecipientIdentityVerification implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientIdentityVerification'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class RecipientIdentityVerification implements ArrayAccess 'workflow_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'input_options' => null, + 'workflow_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'workflow_id' => 'workflowId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'workflow_id' => 'setWorkflowId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'workflow_id' => 'getWorkflowId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets input_options + * * @return \DocuSign\eSign\Model\RecipientIdentityInputOption[] */ public function getInputOptions() @@ -161,7 +222,9 @@ public function getInputOptions() /** * Sets input_options + * * @param \DocuSign\eSign\Model\RecipientIdentityInputOption[] $input_options + * * @return $this */ public function setInputOptions($input_options) @@ -173,6 +236,7 @@ public function setInputOptions($input_options) /** * Gets workflow_id + * * @return string */ public function getWorkflowId() @@ -182,7 +246,9 @@ public function getWorkflowId() /** * Sets workflow_id + * * @param string $workflow_id + * * @return $this */ public function setWorkflowId($workflow_id) @@ -193,7 +259,9 @@ public function setWorkflowId($workflow_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientNamesResponse.php b/src/Model/RecipientNamesResponse.php index 2d0d3ac1..6a543777 100644 --- a/src/Model/RecipientNamesResponse.php +++ b/src/Model/RecipientNamesResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientNamesResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientNamesResponse implements ArrayAccess +class RecipientNamesResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientNamesResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class RecipientNamesResponse implements ArrayAccess 'reserved_recipient_email' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'multiple_users' => null, + 'recipient_names' => null, + 'reserved_recipient_email' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'reserved_recipient_email' => 'reservedRecipientEmail' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'reserved_recipient_email' => 'setReservedRecipientEmail' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'reserved_recipient_email' => 'getReservedRecipientEmail' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets multiple_users + * * @return string */ public function getMultipleUsers() @@ -166,7 +228,9 @@ public function getMultipleUsers() /** * Sets multiple_users + * * @param string $multiple_users Indicates whether email address is used by more than one user. + * * @return $this */ public function setMultipleUsers($multiple_users) @@ -178,6 +242,7 @@ public function setMultipleUsers($multiple_users) /** * Gets recipient_names + * * @return string[] */ public function getRecipientNames() @@ -187,7 +252,9 @@ public function getRecipientNames() /** * Sets recipient_names + * * @param string[] $recipient_names + * * @return $this */ public function setRecipientNames($recipient_names) @@ -199,6 +266,7 @@ public function setRecipientNames($recipient_names) /** * Gets reserved_recipient_email + * * @return string */ public function getReservedRecipientEmail() @@ -208,7 +276,9 @@ public function getReservedRecipientEmail() /** * Sets reserved_recipient_email + * * @param string $reserved_recipient_email + * * @return $this */ public function setReservedRecipientEmail($reserved_recipient_email) @@ -219,7 +289,9 @@ public function setReservedRecipientEmail($reserved_recipient_email) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientPhoneAuthentication.php b/src/Model/RecipientPhoneAuthentication.php index 0f9cf67c..4e959532 100644 --- a/src/Model/RecipientPhoneAuthentication.php +++ b/src/Model/RecipientPhoneAuthentication.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientPhoneAuthentication Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientPhoneAuthentication implements ArrayAccess +class RecipientPhoneAuthentication implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientPhoneAuthentication'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,46 @@ class RecipientPhoneAuthentication implements ArrayAccess 'validate_recip_provided_number_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'recip_may_provide_number' => null, + 'recip_may_provide_number_metadata' => null, + 'record_voice_print' => null, + 'record_voice_print_metadata' => null, + 'sender_provided_numbers' => null, + 'sender_provided_numbers_metadata' => null, + 'validate_recip_provided_number' => null, + 'validate_recip_provided_number_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -85,9 +121,9 @@ public static function swaggerTypes() 'validate_recip_provided_number_metadata' => 'validateRecipProvidedNumberMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -101,9 +137,9 @@ public static function swaggerTypes() 'validate_recip_provided_number_metadata' => 'setValidateRecipProvidedNumberMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -117,34 +153,63 @@ public static function swaggerTypes() 'validate_recip_provided_number_metadata' => 'getValidateRecipProvidedNumberMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -159,30 +224,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets recip_may_provide_number + * * @return string */ public function getRecipMayProvideNumber() @@ -192,7 +259,9 @@ public function getRecipMayProvideNumber() /** * Sets recip_may_provide_number + * * @param string $recip_may_provide_number Boolean. When set to **true**, the recipient can supply a phone number their choice. + * * @return $this */ public function setRecipMayProvideNumber($recip_may_provide_number) @@ -204,6 +273,7 @@ public function setRecipMayProvideNumber($recip_may_provide_number) /** * Gets recip_may_provide_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipMayProvideNumberMetadata() @@ -213,7 +283,9 @@ public function getRecipMayProvideNumberMetadata() /** * Sets recip_may_provide_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recip_may_provide_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recip_may_provide_number_metadata recip_may_provide_number_metadata + * * @return $this */ public function setRecipMayProvideNumberMetadata($recip_may_provide_number_metadata) @@ -225,6 +297,7 @@ public function setRecipMayProvideNumberMetadata($recip_may_provide_number_metad /** * Gets record_voice_print + * * @return string */ public function getRecordVoicePrint() @@ -234,7 +307,9 @@ public function getRecordVoicePrint() /** * Sets record_voice_print + * * @param string $record_voice_print Reserved. + * * @return $this */ public function setRecordVoicePrint($record_voice_print) @@ -246,6 +321,7 @@ public function setRecordVoicePrint($record_voice_print) /** * Gets record_voice_print_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecordVoicePrintMetadata() @@ -255,7 +331,9 @@ public function getRecordVoicePrintMetadata() /** * Sets record_voice_print_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $record_voice_print_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $record_voice_print_metadata record_voice_print_metadata + * * @return $this */ public function setRecordVoicePrintMetadata($record_voice_print_metadata) @@ -267,6 +345,7 @@ public function setRecordVoicePrintMetadata($record_voice_print_metadata) /** * Gets sender_provided_numbers + * * @return string[] */ public function getSenderProvidedNumbers() @@ -276,7 +355,9 @@ public function getSenderProvidedNumbers() /** * Sets sender_provided_numbers + * * @param string[] $sender_provided_numbers An Array containing a list of phone numbers the recipient may use for SMS text authentication. + * * @return $this */ public function setSenderProvidedNumbers($sender_provided_numbers) @@ -288,6 +369,7 @@ public function setSenderProvidedNumbers($sender_provided_numbers) /** * Gets sender_provided_numbers_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderProvidedNumbersMetadata() @@ -297,7 +379,9 @@ public function getSenderProvidedNumbersMetadata() /** * Sets sender_provided_numbers_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_provided_numbers_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_provided_numbers_metadata sender_provided_numbers_metadata + * * @return $this */ public function setSenderProvidedNumbersMetadata($sender_provided_numbers_metadata) @@ -309,6 +393,7 @@ public function setSenderProvidedNumbersMetadata($sender_provided_numbers_metada /** * Gets validate_recip_provided_number + * * @return string */ public function getValidateRecipProvidedNumber() @@ -318,7 +403,9 @@ public function getValidateRecipProvidedNumber() /** * Sets validate_recip_provided_number + * * @param string $validate_recip_provided_number Reserved. + * * @return $this */ public function setValidateRecipProvidedNumber($validate_recip_provided_number) @@ -330,6 +417,7 @@ public function setValidateRecipProvidedNumber($validate_recip_provided_number) /** * Gets validate_recip_provided_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidateRecipProvidedNumberMetadata() @@ -339,7 +427,9 @@ public function getValidateRecipProvidedNumberMetadata() /** * Sets validate_recip_provided_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validate_recip_provided_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validate_recip_provided_number_metadata validate_recip_provided_number_metadata + * * @return $this */ public function setValidateRecipProvidedNumberMetadata($validate_recip_provided_number_metadata) @@ -350,7 +440,9 @@ public function setValidateRecipProvidedNumberMetadata($validate_recip_provided_ } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -360,7 +452,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -370,8 +464,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -385,7 +481,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -395,16 +493,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientPhoneNumber.php b/src/Model/RecipientPhoneNumber.php new file mode 100644 index 00000000..d6d6c0dd --- /dev/null +++ b/src/Model/RecipientPhoneNumber.php @@ -0,0 +1,390 @@ + 'string', + 'country_code_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', + 'number' => 'string', + 'number_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'country_code' => null, + 'country_code_metadata' => null, + 'number' => null, + 'number_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'country_code' => 'countryCode', + 'country_code_metadata' => 'countryCodeMetadata', + 'number' => 'number', + 'number_metadata' => 'numberMetadata' + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'country_code' => 'setCountryCode', + 'country_code_metadata' => 'setCountryCodeMetadata', + 'number' => 'setNumber', + 'number_metadata' => 'setNumberMetadata' + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'country_code' => 'getCountryCode', + 'country_code_metadata' => 'getCountryCodeMetadata', + 'number' => 'getNumber', + 'number_metadata' => 'getNumberMetadata' + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + + + + + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->container['country_code'] = isset($data['country_code']) ? $data['country_code'] : null; + $this->container['country_code_metadata'] = isset($data['country_code_metadata']) ? $data['country_code_metadata'] : null; + $this->container['number'] = isset($data['number']) ? $data['number'] : null; + $this->container['number_metadata'] = isset($data['number_metadata']) ? $data['number_metadata'] : null; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + + /** + * Gets 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 country_code_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getCountryCodeMetadata() + { + return $this->container['country_code_metadata']; + } + + /** + * Sets country_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $country_code_metadata country_code_metadata + * + * @return $this + */ + public function setCountryCodeMetadata($country_code_metadata) + { + $this->container['country_code_metadata'] = $country_code_metadata; + + return $this; + } + + /** + * Gets number + * + * @return string + */ + public function getNumber() + { + return $this->container['number']; + } + + /** + * Sets number + * + * @param string $number + * + * @return $this + */ + public function setNumber($number) + { + $this->container['number'] = $number; + + return $this; + } + + /** + * Gets number_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getNumberMetadata() + { + return $this->container['number_metadata']; + } + + /** + * Sets number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $number_metadata number_metadata + * + * @return $this + */ + public function setNumberMetadata($number_metadata) + { + $this->container['number_metadata'] = $number_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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); + } + + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} + diff --git a/src/Model/RecipientPreviewRequest.php b/src/Model/RecipientPreviewRequest.php index 66d313b5..fc6be5c3 100644 --- a/src/Model/RecipientPreviewRequest.php +++ b/src/Model/RecipientPreviewRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientPreviewRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientPreviewRequest implements ArrayAccess +class RecipientPreviewRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientPreviewRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class RecipientPreviewRequest implements ArrayAccess 'x_frame_options_allow_from_url' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'assertion_id' => null, + 'authentication_instant' => null, + 'authentication_method' => null, + 'ping_frequency' => null, + 'ping_url' => null, + 'recipient_id' => null, + 'return_url' => null, + 'security_domain' => null, + 'x_frame_options' => null, + 'x_frame_options_allow_from_url' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'x_frame_options_allow_from_url' => 'xFrameOptionsAllowFromUrl' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'x_frame_options_allow_from_url' => 'setXFrameOptionsAllowFromUrl' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'x_frame_options_allow_from_url' => 'getXFrameOptionsAllowFromUrl' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets assertion_id + * * @return string */ public function getAssertionId() @@ -201,7 +270,9 @@ public function getAssertionId() /** * Sets assertion_id + * * @param string $assertion_id + * * @return $this */ public function setAssertionId($assertion_id) @@ -213,6 +284,7 @@ public function setAssertionId($assertion_id) /** * Gets authentication_instant + * * @return string */ public function getAuthenticationInstant() @@ -222,7 +294,9 @@ public function getAuthenticationInstant() /** * Sets authentication_instant + * * @param string $authentication_instant + * * @return $this */ public function setAuthenticationInstant($authentication_instant) @@ -234,6 +308,7 @@ public function setAuthenticationInstant($authentication_instant) /** * Gets authentication_method + * * @return string */ public function getAuthenticationMethod() @@ -243,7 +318,9 @@ public function getAuthenticationMethod() /** * Sets authentication_method + * * @param string $authentication_method + * * @return $this */ public function setAuthenticationMethod($authentication_method) @@ -255,6 +332,7 @@ public function setAuthenticationMethod($authentication_method) /** * Gets ping_frequency + * * @return string */ public function getPingFrequency() @@ -264,7 +342,9 @@ public function getPingFrequency() /** * Sets ping_frequency + * * @param string $ping_frequency + * * @return $this */ public function setPingFrequency($ping_frequency) @@ -276,6 +356,7 @@ public function setPingFrequency($ping_frequency) /** * Gets ping_url + * * @return string */ public function getPingUrl() @@ -285,7 +366,9 @@ public function getPingUrl() /** * Sets ping_url + * * @param string $ping_url + * * @return $this */ public function setPingUrl($ping_url) @@ -297,6 +380,7 @@ public function setPingUrl($ping_url) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -306,7 +390,9 @@ public function getRecipientId() /** * 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) @@ -318,6 +404,7 @@ public function setRecipientId($recipient_id) /** * Gets return_url + * * @return string */ public function getReturnUrl() @@ -327,7 +414,9 @@ public function getReturnUrl() /** * Sets return_url + * * @param string $return_url + * * @return $this */ public function setReturnUrl($return_url) @@ -339,6 +428,7 @@ public function setReturnUrl($return_url) /** * Gets security_domain + * * @return string */ public function getSecurityDomain() @@ -348,7 +438,9 @@ public function getSecurityDomain() /** * Sets security_domain + * * @param string $security_domain + * * @return $this */ public function setSecurityDomain($security_domain) @@ -360,6 +452,7 @@ public function setSecurityDomain($security_domain) /** * Gets x_frame_options + * * @return string */ public function getXFrameOptions() @@ -369,7 +462,9 @@ public function getXFrameOptions() /** * Sets x_frame_options + * * @param string $x_frame_options + * * @return $this */ public function setXFrameOptions($x_frame_options) @@ -381,6 +476,7 @@ public function setXFrameOptions($x_frame_options) /** * Gets x_frame_options_allow_from_url + * * @return string */ public function getXFrameOptionsAllowFromUrl() @@ -390,7 +486,9 @@ public function getXFrameOptionsAllowFromUrl() /** * Sets x_frame_options_allow_from_url + * * @param string $x_frame_options_allow_from_url + * * @return $this */ public function setXFrameOptionsAllowFromUrl($x_frame_options_allow_from_url) @@ -401,7 +499,9 @@ public function setXFrameOptionsAllowFromUrl($x_frame_options_allow_from_url) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientProofFile.php b/src/Model/RecipientProofFile.php index 6a462088..54c34b44 100644 --- a/src/Model/RecipientProofFile.php +++ b/src/Model/RecipientProofFile.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientProofFile Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientProofFile implements ArrayAccess +class RecipientProofFile implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientProofFile'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'is_in_proof_file' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'is_in_proof_file' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'is_in_proof_file' => 'isInProofFile' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'is_in_proof_file' => 'setIsInProofFile' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'is_in_proof_file' => 'getIsInProofFile' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets is_in_proof_file + * * @return string */ public function getIsInProofFile() @@ -156,7 +216,9 @@ public function getIsInProofFile() /** * Sets is_in_proof_file + * * @param string $is_in_proof_file + * * @return $this */ public function setIsInProofFile($is_in_proof_file) @@ -167,7 +229,9 @@ public function setIsInProofFile($is_in_proof_file) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientSMSAuthentication.php b/src/Model/RecipientSMSAuthentication.php index 15b286ef..fb3e8c97 100644 --- a/src/Model/RecipientSMSAuthentication.php +++ b/src/Model/RecipientSMSAuthentication.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientSMSAuthentication Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientSMSAuthentication implements ArrayAccess +class RecipientSMSAuthentication implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientSMSAuthentication'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,40 @@ class RecipientSMSAuthentication implements ArrayAccess 'sender_provided_numbers_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'sender_provided_numbers' => null, + 'sender_provided_numbers_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -73,9 +103,9 @@ public static function swaggerTypes() 'sender_provided_numbers_metadata' => 'senderProvidedNumbersMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -83,9 +113,9 @@ public static function swaggerTypes() 'sender_provided_numbers_metadata' => 'setSenderProvidedNumbersMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -93,34 +123,63 @@ public static function swaggerTypes() 'sender_provided_numbers_metadata' => 'getSenderProvidedNumbersMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -129,30 +188,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets sender_provided_numbers + * * @return string[] */ public function getSenderProvidedNumbers() @@ -162,7 +223,9 @@ public function getSenderProvidedNumbers() /** * Sets sender_provided_numbers + * * @param string[] $sender_provided_numbers An Array containing a list of phone numbers the recipient may use for SMS text authentication. + * * @return $this */ public function setSenderProvidedNumbers($sender_provided_numbers) @@ -174,6 +237,7 @@ public function setSenderProvidedNumbers($sender_provided_numbers) /** * Gets sender_provided_numbers_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderProvidedNumbersMetadata() @@ -183,7 +247,9 @@ public function getSenderProvidedNumbersMetadata() /** * Sets sender_provided_numbers_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_provided_numbers_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_provided_numbers_metadata sender_provided_numbers_metadata + * * @return $this */ public function setSenderProvidedNumbersMetadata($sender_provided_numbers_metadata) @@ -194,7 +260,9 @@ public function setSenderProvidedNumbersMetadata($sender_provided_numbers_metada } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -204,7 +272,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -214,8 +284,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -229,7 +301,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -239,16 +313,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientSignatureInformation.php b/src/Model/RecipientSignatureInformation.php index dbbef685..2c9e938e 100644 --- a/src/Model/RecipientSignatureInformation.php +++ b/src/Model/RecipientSignatureInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientSignatureInformation Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientSignatureInformation implements ArrayAccess +class RecipientSignatureInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientSignatureInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class RecipientSignatureInformation implements ArrayAccess 'signature_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'font_style' => null, + 'signature_initials' => null, + 'signature_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'signature_name' => 'signatureName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'signature_name' => 'setSignatureName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'signature_name' => 'getSignatureName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets font_style + * * @return string */ public function getFontStyle() @@ -167,7 +229,9 @@ public function getFontStyle() /** * Sets font_style + * * @param string $font_style + * * @return $this */ public function setFontStyle($font_style) @@ -179,6 +243,7 @@ public function setFontStyle($font_style) /** * Gets signature_initials + * * @return string */ public function getSignatureInitials() @@ -188,7 +253,9 @@ public function getSignatureInitials() /** * Sets signature_initials + * * @param string $signature_initials + * * @return $this */ public function setSignatureInitials($signature_initials) @@ -200,6 +267,7 @@ public function setSignatureInitials($signature_initials) /** * Gets signature_name + * * @return string */ public function getSignatureName() @@ -209,7 +277,9 @@ public function getSignatureName() /** * Sets signature_name + * * @param string $signature_name Specifies the user signature name. + * * @return $this */ public function setSignatureName($signature_name) @@ -220,7 +290,9 @@ public function setSignatureName($signature_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientSignatureProvider.php b/src/Model/RecipientSignatureProvider.php index acc961fd..1b909551 100644 --- a/src/Model/RecipientSignatureProvider.php +++ b/src/Model/RecipientSignatureProvider.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientSignatureProvider Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientSignatureProvider implements ArrayAccess +class RecipientSignatureProvider implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientSignatureProvider'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class RecipientSignatureProvider implements ArrayAccess 'signature_provider_options' => '\DocuSign\eSign\Model\RecipientSignatureProviderOptions' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'seal_documents_with_tabs_only' => null, + 'seal_name' => null, + 'signature_provider_name' => null, + 'signature_provider_name_metadata' => null, + 'signature_provider_options' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'signature_provider_options' => 'signatureProviderOptions' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'signature_provider_options' => 'setSignatureProviderOptions' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'signature_provider_options' => 'getSignatureProviderOptions' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets seal_documents_with_tabs_only + * * @return string */ public function getSealDocumentsWithTabsOnly() @@ -176,7 +240,9 @@ public function getSealDocumentsWithTabsOnly() /** * Sets seal_documents_with_tabs_only + * * @param string $seal_documents_with_tabs_only + * * @return $this */ public function setSealDocumentsWithTabsOnly($seal_documents_with_tabs_only) @@ -188,6 +254,7 @@ public function setSealDocumentsWithTabsOnly($seal_documents_with_tabs_only) /** * Gets seal_name + * * @return string */ public function getSealName() @@ -197,7 +264,9 @@ public function getSealName() /** * Sets seal_name + * * @param string $seal_name + * * @return $this */ public function setSealName($seal_name) @@ -209,6 +278,7 @@ public function setSealName($seal_name) /** * Gets signature_provider_name + * * @return string */ public function getSignatureProviderName() @@ -218,7 +288,9 @@ public function getSignatureProviderName() /** * Sets signature_provider_name + * * @param string $signature_provider_name + * * @return $this */ public function setSignatureProviderName($signature_provider_name) @@ -230,6 +302,7 @@ public function setSignatureProviderName($signature_provider_name) /** * Gets signature_provider_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignatureProviderNameMetadata() @@ -239,7 +312,9 @@ public function getSignatureProviderNameMetadata() /** * Sets signature_provider_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signature_provider_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signature_provider_name_metadata signature_provider_name_metadata + * * @return $this */ public function setSignatureProviderNameMetadata($signature_provider_name_metadata) @@ -251,6 +326,7 @@ public function setSignatureProviderNameMetadata($signature_provider_name_metada /** * Gets signature_provider_options + * * @return \DocuSign\eSign\Model\RecipientSignatureProviderOptions */ public function getSignatureProviderOptions() @@ -260,7 +336,9 @@ public function getSignatureProviderOptions() /** * Sets signature_provider_options - * @param \DocuSign\eSign\Model\RecipientSignatureProviderOptions $signature_provider_options + * + * @param \DocuSign\eSign\Model\RecipientSignatureProviderOptions $signature_provider_options signature_provider_options + * * @return $this */ public function setSignatureProviderOptions($signature_provider_options) @@ -271,7 +349,9 @@ public function setSignatureProviderOptions($signature_provider_options) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientSignatureProviderOptions.php b/src/Model/RecipientSignatureProviderOptions.php index f98e390d..0b4ad7f4 100644 --- a/src/Model/RecipientSignatureProviderOptions.php +++ b/src/Model/RecipientSignatureProviderOptions.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientSignatureProviderOptions Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientSignatureProviderOptions implements ArrayAccess +class RecipientSignatureProviderOptions implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientSignatureProviderOptions'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class RecipientSignatureProviderOptions implements ArrayAccess 'sms_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'cpf_number' => null, + 'cpf_number_metadata' => null, + 'one_time_password' => null, + 'one_time_password_metadata' => null, + 'signer_role' => null, + 'signer_role_metadata' => null, + 'sms' => null, + 'sms_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'sms_metadata' => 'smsMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'sms_metadata' => 'setSmsMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'sms_metadata' => 'getSmsMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets cpf_number + * * @return string */ public function getCpfNumber() @@ -191,7 +258,9 @@ public function getCpfNumber() /** * Sets cpf_number + * * @param string $cpf_number + * * @return $this */ public function setCpfNumber($cpf_number) @@ -203,6 +272,7 @@ public function setCpfNumber($cpf_number) /** * Gets cpf_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCpfNumberMetadata() @@ -212,7 +282,9 @@ public function getCpfNumberMetadata() /** * Sets cpf_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $cpf_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $cpf_number_metadata cpf_number_metadata + * * @return $this */ public function setCpfNumberMetadata($cpf_number_metadata) @@ -224,6 +296,7 @@ public function setCpfNumberMetadata($cpf_number_metadata) /** * Gets one_time_password + * * @return string */ public function getOneTimePassword() @@ -233,7 +306,9 @@ public function getOneTimePassword() /** * Sets one_time_password + * * @param string $one_time_password + * * @return $this */ public function setOneTimePassword($one_time_password) @@ -245,6 +320,7 @@ public function setOneTimePassword($one_time_password) /** * Gets one_time_password_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOneTimePasswordMetadata() @@ -254,7 +330,9 @@ public function getOneTimePasswordMetadata() /** * Sets one_time_password_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $one_time_password_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $one_time_password_metadata one_time_password_metadata + * * @return $this */ public function setOneTimePasswordMetadata($one_time_password_metadata) @@ -266,6 +344,7 @@ public function setOneTimePasswordMetadata($one_time_password_metadata) /** * Gets signer_role + * * @return string */ public function getSignerRole() @@ -275,7 +354,9 @@ public function getSignerRole() /** * Sets signer_role + * * @param string $signer_role + * * @return $this */ public function setSignerRole($signer_role) @@ -287,6 +368,7 @@ public function setSignerRole($signer_role) /** * Gets signer_role_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignerRoleMetadata() @@ -296,7 +378,9 @@ public function getSignerRoleMetadata() /** * Sets signer_role_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signer_role_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signer_role_metadata signer_role_metadata + * * @return $this */ public function setSignerRoleMetadata($signer_role_metadata) @@ -308,6 +392,7 @@ public function setSignerRoleMetadata($signer_role_metadata) /** * Gets sms + * * @return string */ public function getSms() @@ -317,7 +402,9 @@ public function getSms() /** * Sets sms + * * @param string $sms + * * @return $this */ public function setSms($sms) @@ -329,6 +416,7 @@ public function setSms($sms) /** * Gets sms_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSmsMetadata() @@ -338,7 +426,9 @@ public function getSmsMetadata() /** * Sets sms_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sms_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sms_metadata sms_metadata + * * @return $this */ public function setSmsMetadata($sms_metadata) @@ -349,7 +439,9 @@ public function setSmsMetadata($sms_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientUpdateResponse.php b/src/Model/RecipientUpdateResponse.php index bbc5c302..f23be370 100644 --- a/src/Model/RecipientUpdateResponse.php +++ b/src/Model/RecipientUpdateResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientUpdateResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientUpdateResponse implements ArrayAccess +class RecipientUpdateResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientUpdateResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class RecipientUpdateResponse implements ArrayAccess 'tabs' => '\DocuSign\eSign\Model\Tabs' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'combined' => null, + 'error_details' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'tabs' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'tabs' => 'tabs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'tabs' => 'setTabs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'tabs' => 'getTabs' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets combined + * * @return string */ public function getCombined() @@ -176,7 +240,9 @@ public function getCombined() /** * Sets combined + * * @param string $combined + * * @return $this */ public function setCombined($combined) @@ -188,6 +254,7 @@ public function setCombined($combined) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -197,7 +264,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -209,6 +278,7 @@ public function setErrorDetails($error_details) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -218,7 +288,9 @@ public function getRecipientId() /** * 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) @@ -230,6 +302,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -239,7 +312,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -251,6 +326,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -260,7 +336,9 @@ public function getTabs() /** * Sets tabs - * @param \DocuSign\eSign\Model\Tabs $tabs + * + * @param \DocuSign\eSign\Model\Tabs $tabs tabs + * * @return $this */ public function setTabs($tabs) @@ -271,7 +349,9 @@ public function setTabs($tabs) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientViewRequest.php b/src/Model/RecipientViewRequest.php index e4b687fd..74351e11 100644 --- a/src/Model/RecipientViewRequest.php +++ b/src/Model/RecipientViewRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientViewRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientViewRequest implements ArrayAccess +class RecipientViewRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientViewRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,6 +62,8 @@ class RecipientViewRequest implements ArrayAccess 'authentication_method' => 'string', 'client_user_id' => 'string', 'email' => 'string', + 'frame_ancestors' => 'string[]', + 'message_origins' => 'string[]', 'ping_frequency' => 'string', 'ping_url' => 'string', 'recipient_id' => 'string', @@ -70,13 +75,54 @@ class RecipientViewRequest implements ArrayAccess 'x_frame_options_allow_from_url' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'assertion_id' => null, + 'authentication_instant' => null, + 'authentication_method' => null, + 'client_user_id' => null, + 'email' => null, + 'frame_ancestors' => null, + 'message_origins' => null, + 'ping_frequency' => null, + 'ping_url' => null, + 'recipient_id' => null, + 'return_url' => null, + 'security_domain' => null, + 'user_id' => null, + 'user_name' => null, + 'x_frame_options' => null, + 'x_frame_options_allow_from_url' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -85,6 +131,8 @@ public static function swaggerTypes() 'authentication_method' => 'authenticationMethod', 'client_user_id' => 'clientUserId', 'email' => 'email', + 'frame_ancestors' => 'frameAncestors', + 'message_origins' => 'messageOrigins', 'ping_frequency' => 'pingFrequency', 'ping_url' => 'pingUrl', 'recipient_id' => 'recipientId', @@ -96,9 +144,9 @@ public static function swaggerTypes() 'x_frame_options_allow_from_url' => 'xFrameOptionsAllowFromUrl' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -107,6 +155,8 @@ public static function swaggerTypes() 'authentication_method' => 'setAuthenticationMethod', 'client_user_id' => 'setClientUserId', 'email' => 'setEmail', + 'frame_ancestors' => 'setFrameAncestors', + 'message_origins' => 'setMessageOrigins', 'ping_frequency' => 'setPingFrequency', 'ping_url' => 'setPingUrl', 'recipient_id' => 'setRecipientId', @@ -118,9 +168,9 @@ public static function swaggerTypes() 'x_frame_options_allow_from_url' => 'setXFrameOptionsAllowFromUrl' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -129,6 +179,8 @@ public static function swaggerTypes() 'authentication_method' => 'getAuthenticationMethod', 'client_user_id' => 'getClientUserId', 'email' => 'getEmail', + 'frame_ancestors' => 'getFrameAncestors', + 'message_origins' => 'getMessageOrigins', 'ping_frequency' => 'getPingFrequency', 'ping_url' => 'getPingUrl', 'recipient_id' => 'getRecipientId', @@ -140,34 +192,63 @@ public static function swaggerTypes() 'x_frame_options_allow_from_url' => 'getXFrameOptionsAllowFromUrl' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -176,6 +257,8 @@ public function __construct(array $data = null) $this->container['authentication_method'] = isset($data['authentication_method']) ? $data['authentication_method'] : null; $this->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; + $this->container['frame_ancestors'] = isset($data['frame_ancestors']) ? $data['frame_ancestors'] : null; + $this->container['message_origins'] = isset($data['message_origins']) ? $data['message_origins'] : null; $this->container['ping_frequency'] = isset($data['ping_frequency']) ? $data['ping_frequency'] : null; $this->container['ping_url'] = isset($data['ping_url']) ? $data['ping_url'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; @@ -188,30 +271,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets assertion_id + * * @return string */ public function getAssertionId() @@ -221,7 +306,9 @@ public function getAssertionId() /** * Sets assertion_id + * * @param string $assertion_id A unique identifier of the authentication event executed by the client application. + * * @return $this */ public function setAssertionId($assertion_id) @@ -233,6 +320,7 @@ public function setAssertionId($assertion_id) /** * Gets authentication_instant + * * @return string */ public function getAuthenticationInstant() @@ -242,7 +330,9 @@ public function getAuthenticationInstant() /** * Sets authentication_instant + * * @param string $authentication_instant A sender generated value that indicates the date/time that the signer was authenticated. + * * @return $this */ public function setAuthenticationInstant($authentication_instant) @@ -254,6 +344,7 @@ public function setAuthenticationInstant($authentication_instant) /** * Gets authentication_method + * * @return string */ public function getAuthenticationMethod() @@ -263,7 +354,9 @@ public function getAuthenticationMethod() /** * Sets authentication_method + * * @param string $authentication_method A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion. + * * @return $this */ public function setAuthenticationMethod($authentication_method) @@ -275,6 +368,7 @@ public function setAuthenticationMethod($authentication_method) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -284,7 +378,9 @@ public function getClientUserId() /** * Sets client_user_id + * * @param string $client_user_id A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters. + * * @return $this */ public function setClientUserId($client_user_id) @@ -296,6 +392,7 @@ public function setClientUserId($client_user_id) /** * Gets email + * * @return string */ public function getEmail() @@ -305,7 +402,9 @@ public function getEmail() /** * Sets email + * * @param string $email Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient. + * * @return $this */ public function setEmail($email) @@ -315,8 +414,57 @@ public function setEmail($email) return $this; } + /** + * Gets frame_ancestors + * + * @return string[] + */ + public function getFrameAncestors() + { + return $this->container['frame_ancestors']; + } + + /** + * Sets frame_ancestors + * + * @param string[] $frame_ancestors + * + * @return $this + */ + public function setFrameAncestors($frame_ancestors) + { + $this->container['frame_ancestors'] = $frame_ancestors; + + return $this; + } + + /** + * Gets message_origins + * + * @return string[] + */ + public function getMessageOrigins() + { + return $this->container['message_origins']; + } + + /** + * Sets message_origins + * + * @param string[] $message_origins + * + * @return $this + */ + public function setMessageOrigins($message_origins) + { + $this->container['message_origins'] = $message_origins; + + return $this; + } + /** * Gets ping_frequency + * * @return string */ public function getPingFrequency() @@ -326,7 +474,9 @@ public function getPingFrequency() /** * Sets ping_frequency + * * @param string $ping_frequency Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds. + * * @return $this */ public function setPingFrequency($ping_frequency) @@ -338,6 +488,7 @@ public function setPingFrequency($ping_frequency) /** * Gets ping_url + * * @return string */ public function getPingUrl() @@ -347,7 +498,9 @@ public function getPingUrl() /** * Sets ping_url + * * @param string $ping_url A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received. + * * @return $this */ public function setPingUrl($ping_url) @@ -359,6 +512,7 @@ public function setPingUrl($ping_url) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -368,7 +522,9 @@ public function getRecipientId() /** * 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) @@ -380,6 +536,7 @@ public function setRecipientId($recipient_id) /** * Gets return_url + * * @return string */ public function getReturnUrl() @@ -389,7 +546,9 @@ public function getReturnUrl() /** * Sets return_url + * * @param string $return_url The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. + * * @return $this */ public function setReturnUrl($return_url) @@ -401,6 +560,7 @@ public function setReturnUrl($return_url) /** * Gets security_domain + * * @return string */ public function getSecurityDomain() @@ -410,7 +570,9 @@ public function getSecurityDomain() /** * Sets security_domain + * * @param string $security_domain The domain in which the user authenticated. + * * @return $this */ public function setSecurityDomain($security_domain) @@ -422,6 +584,7 @@ public function setSecurityDomain($security_domain) /** * Gets user_id + * * @return string */ public function getUserId() @@ -431,7 +594,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the `userId` property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user. + * * @return $this */ public function setUserId($user_id) @@ -443,6 +608,7 @@ public function setUserId($user_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -452,7 +618,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient. + * * @return $this */ public function setUserName($user_name) @@ -464,6 +632,7 @@ public function setUserName($user_name) /** * Gets x_frame_options + * * @return string */ public function getXFrameOptions() @@ -473,7 +642,9 @@ public function getXFrameOptions() /** * Sets x_frame_options + * * @param string $x_frame_options + * * @return $this */ public function setXFrameOptions($x_frame_options) @@ -485,6 +656,7 @@ public function setXFrameOptions($x_frame_options) /** * Gets x_frame_options_allow_from_url + * * @return string */ public function getXFrameOptionsAllowFromUrl() @@ -494,7 +666,9 @@ public function getXFrameOptionsAllowFromUrl() /** * Sets x_frame_options_allow_from_url + * * @param string $x_frame_options_allow_from_url + * * @return $this */ public function setXFrameOptionsAllowFromUrl($x_frame_options_allow_from_url) @@ -505,7 +679,9 @@ public function setXFrameOptionsAllowFromUrl($x_frame_options_allow_from_url) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -515,7 +691,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -525,8 +703,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -540,7 +720,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -550,16 +732,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Recipients.php b/src/Model/Recipients.php index edd244f0..168b312c 100644 --- a/src/Model/Recipients.php +++ b/src/Model/Recipients.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Recipients Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Recipients implements ArrayAccess +class Recipients implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipients'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -69,13 +72,50 @@ class Recipients implements ArrayAccess 'witnesses' => '\DocuSign\eSign\Model\Witness[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'agents' => null, + 'carbon_copies' => null, + 'certified_deliveries' => null, + 'current_routing_order' => null, + 'editors' => null, + 'error_details' => null, + 'in_person_signers' => null, + 'intermediaries' => null, + 'recipient_count' => null, + 'seals' => null, + 'signers' => null, + 'witnesses' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -93,9 +133,9 @@ public static function swaggerTypes() 'witnesses' => 'witnesses' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -113,9 +153,9 @@ public static function swaggerTypes() 'witnesses' => 'setWitnesses' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -133,34 +173,63 @@ public static function swaggerTypes() 'witnesses' => 'getWitnesses' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -179,30 +248,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets agents + * * @return \DocuSign\eSign\Model\Agent[] */ public function getAgents() @@ -212,7 +283,9 @@ public function getAgents() /** * Sets agents + * * @param \DocuSign\eSign\Model\Agent[] $agents A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. + * * @return $this */ public function setAgents($agents) @@ -224,6 +297,7 @@ public function setAgents($agents) /** * Gets carbon_copies + * * @return \DocuSign\eSign\Model\CarbonCopy[] */ public function getCarbonCopies() @@ -233,7 +307,9 @@ public function getCarbonCopies() /** * Sets carbon_copies + * * @param \DocuSign\eSign\Model\CarbonCopy[] $carbon_copies A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. + * * @return $this */ public function setCarbonCopies($carbon_copies) @@ -245,6 +321,7 @@ public function setCarbonCopies($carbon_copies) /** * Gets certified_deliveries + * * @return \DocuSign\eSign\Model\CertifiedDelivery[] */ public function getCertifiedDeliveries() @@ -254,7 +331,9 @@ public function getCertifiedDeliveries() /** * Sets certified_deliveries + * * @param \DocuSign\eSign\Model\CertifiedDelivery[] $certified_deliveries A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. + * * @return $this */ public function setCertifiedDeliveries($certified_deliveries) @@ -266,6 +345,7 @@ public function setCertifiedDeliveries($certified_deliveries) /** * Gets current_routing_order + * * @return string */ public function getCurrentRoutingOrder() @@ -275,7 +355,9 @@ public function getCurrentRoutingOrder() /** * Sets current_routing_order + * * @param string $current_routing_order + * * @return $this */ public function setCurrentRoutingOrder($current_routing_order) @@ -287,6 +369,7 @@ public function setCurrentRoutingOrder($current_routing_order) /** * Gets editors + * * @return \DocuSign\eSign\Model\Editor[] */ public function getEditors() @@ -296,7 +379,9 @@ public function getEditors() /** * Sets editors + * * @param \DocuSign\eSign\Model\Editor[] $editors A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document. + * * @return $this */ public function setEditors($editors) @@ -308,6 +393,7 @@ public function setEditors($editors) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -317,7 +403,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -329,6 +417,7 @@ public function setErrorDetails($error_details) /** * Gets in_person_signers + * * @return \DocuSign\eSign\Model\InPersonSigner[] */ public function getInPersonSigners() @@ -338,7 +427,9 @@ public function getInPersonSigners() /** * Sets in_person_signers + * * @param \DocuSign\eSign\Model\InPersonSigner[] $in_person_signers Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. + * * @return $this */ public function setInPersonSigners($in_person_signers) @@ -350,6 +441,7 @@ public function setInPersonSigners($in_person_signers) /** * Gets intermediaries + * * @return \DocuSign\eSign\Model\Intermediary[] */ public function getIntermediaries() @@ -359,7 +451,9 @@ public function getIntermediaries() /** * Sets intermediaries + * * @param \DocuSign\eSign\Model\Intermediary[] $intermediaries Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). + * * @return $this */ public function setIntermediaries($intermediaries) @@ -371,6 +465,7 @@ public function setIntermediaries($intermediaries) /** * Gets recipient_count + * * @return string */ public function getRecipientCount() @@ -380,7 +475,9 @@ public function getRecipientCount() /** * Sets recipient_count + * * @param string $recipient_count + * * @return $this */ public function setRecipientCount($recipient_count) @@ -392,6 +489,7 @@ public function setRecipientCount($recipient_count) /** * Gets seals + * * @return \DocuSign\eSign\Model\SealSign[] */ public function getSeals() @@ -401,7 +499,9 @@ public function getSeals() /** * Sets seals + * * @param \DocuSign\eSign\Model\SealSign[] $seals + * * @return $this */ public function setSeals($seals) @@ -413,6 +513,7 @@ public function setSeals($seals) /** * Gets signers + * * @return \DocuSign\eSign\Model\Signer[] */ public function getSigners() @@ -422,7 +523,9 @@ public function getSigners() /** * Sets signers + * * @param \DocuSign\eSign\Model\Signer[] $signers A complex type containing information about the Signer recipient. + * * @return $this */ public function setSigners($signers) @@ -434,6 +537,7 @@ public function setSigners($signers) /** * Gets witnesses + * * @return \DocuSign\eSign\Model\Witness[] */ public function getWitnesses() @@ -443,7 +547,9 @@ public function getWitnesses() /** * Sets witnesses + * * @param \DocuSign\eSign\Model\Witness[] $witnesses + * * @return $this */ public function setWitnesses($witnesses) @@ -454,7 +560,9 @@ public function setWitnesses($witnesses) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -464,7 +572,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -474,8 +584,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -489,7 +601,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -499,16 +613,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/RecipientsUpdateSummary.php b/src/Model/RecipientsUpdateSummary.php index f3b3811f..083d0261 100644 --- a/src/Model/RecipientsUpdateSummary.php +++ b/src/Model/RecipientsUpdateSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientsUpdateSummary Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientsUpdateSummary implements ArrayAccess +class RecipientsUpdateSummary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientsUpdateSummary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'recipient_update_results' => '\DocuSign\eSign\Model\RecipientUpdateResponse[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'recipient_update_results' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'recipient_update_results' => 'recipientUpdateResults' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'recipient_update_results' => 'setRecipientUpdateResults' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'recipient_update_results' => 'getRecipientUpdateResults' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets recipient_update_results + * * @return \DocuSign\eSign\Model\RecipientUpdateResponse[] */ public function getRecipientUpdateResults() @@ -156,7 +216,9 @@ public function getRecipientUpdateResults() /** * Sets recipient_update_results + * * @param \DocuSign\eSign\Model\RecipientUpdateResponse[] $recipient_update_results + * * @return $this */ public function setRecipientUpdateResults($recipient_update_results) @@ -167,7 +229,9 @@ public function setRecipientUpdateResults($recipient_update_results) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ReferralInformation.php b/src/Model/ReferralInformation.php index 6c52461a..1c07127c 100644 --- a/src/Model/ReferralInformation.php +++ b/src/Model/ReferralInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ReferralInformation Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ReferralInformation implements ArrayAccess +class ReferralInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'referralInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -75,13 +78,56 @@ class ReferralInformation implements ArrayAccess 'shopper_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'advertisement_id' => null, + 'enable_support' => null, + 'external_org_id' => null, + 'group_member_id' => null, + 'id_type' => null, + 'included_seats' => null, + 'industry' => null, + 'plan_start_month' => null, + 'promo_code' => null, + 'publisher_id' => null, + 'referral_code' => null, + 'referrer_name' => null, + 'sale_discount_amount' => null, + 'sale_discount_fixed_amount' => null, + 'sale_discount_percent' => null, + 'sale_discount_periods' => null, + 'sale_discount_seat_price_override' => null, + 'shopper_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -105,9 +151,9 @@ public static function swaggerTypes() 'shopper_id' => 'shopperId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -131,9 +177,9 @@ public static function swaggerTypes() 'shopper_id' => 'setShopperId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -157,34 +203,63 @@ public static function swaggerTypes() 'shopper_id' => 'getShopperId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -209,30 +284,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets advertisement_id + * * @return string */ public function getAdvertisementId() @@ -242,7 +319,9 @@ public function getAdvertisementId() /** * Sets advertisement_id + * * @param string $advertisement_id A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. + * * @return $this */ public function setAdvertisementId($advertisement_id) @@ -254,6 +333,7 @@ public function setAdvertisementId($advertisement_id) /** * Gets enable_support + * * @return string */ public function getEnableSupport() @@ -263,7 +343,9 @@ public function getEnableSupport() /** * Sets enable_support + * * @param string $enable_support When set to **true**, then customer support is provided as part of the account plan. + * * @return $this */ public function setEnableSupport($enable_support) @@ -275,6 +357,7 @@ public function setEnableSupport($enable_support) /** * Gets external_org_id + * * @return string */ public function getExternalOrgId() @@ -284,7 +367,9 @@ public function getExternalOrgId() /** * Sets external_org_id + * * @param string $external_org_id + * * @return $this */ public function setExternalOrgId($external_org_id) @@ -296,6 +381,7 @@ public function setExternalOrgId($external_org_id) /** * Gets group_member_id + * * @return string */ public function getGroupMemberId() @@ -305,7 +391,9 @@ public function getGroupMemberId() /** * Sets group_member_id + * * @param string $group_member_id + * * @return $this */ public function setGroupMemberId($group_member_id) @@ -317,6 +405,7 @@ public function setGroupMemberId($group_member_id) /** * Gets id_type + * * @return string */ public function getIdType() @@ -326,7 +415,9 @@ public function getIdType() /** * Sets id_type + * * @param string $id_type + * * @return $this */ public function setIdType($id_type) @@ -338,6 +429,7 @@ public function setIdType($id_type) /** * Gets included_seats + * * @return string */ public function getIncludedSeats() @@ -347,7 +439,9 @@ public function getIncludedSeats() /** * Sets included_seats + * * @param string $included_seats The number of seats (users) included. + * * @return $this */ public function setIncludedSeats($included_seats) @@ -359,6 +453,7 @@ public function setIncludedSeats($included_seats) /** * Gets industry + * * @return string */ public function getIndustry() @@ -368,7 +463,9 @@ public function getIndustry() /** * Sets industry + * * @param string $industry + * * @return $this */ public function setIndustry($industry) @@ -380,6 +477,7 @@ public function setIndustry($industry) /** * Gets plan_start_month + * * @return string */ public function getPlanStartMonth() @@ -389,7 +487,9 @@ public function getPlanStartMonth() /** * Sets plan_start_month + * * @param string $plan_start_month + * * @return $this */ public function setPlanStartMonth($plan_start_month) @@ -401,6 +501,7 @@ public function setPlanStartMonth($plan_start_month) /** * Gets promo_code + * * @return string */ public function getPromoCode() @@ -410,7 +511,9 @@ public function getPromoCode() /** * Sets promo_code + * * @param string $promo_code + * * @return $this */ public function setPromoCode($promo_code) @@ -422,6 +525,7 @@ public function setPromoCode($promo_code) /** * Gets publisher_id + * * @return string */ public function getPublisherId() @@ -431,7 +535,9 @@ public function getPublisherId() /** * Sets publisher_id + * * @param string $publisher_id + * * @return $this */ public function setPublisherId($publisher_id) @@ -443,6 +549,7 @@ public function setPublisherId($publisher_id) /** * Gets referral_code + * * @return string */ public function getReferralCode() @@ -452,7 +559,9 @@ public function getReferralCode() /** * Sets referral_code + * * @param string $referral_code + * * @return $this */ public function setReferralCode($referral_code) @@ -464,6 +573,7 @@ public function setReferralCode($referral_code) /** * Gets referrer_name + * * @return string */ public function getReferrerName() @@ -473,7 +583,9 @@ public function getReferrerName() /** * Sets referrer_name + * * @param string $referrer_name + * * @return $this */ public function setReferrerName($referrer_name) @@ -485,6 +597,7 @@ public function setReferrerName($referrer_name) /** * Gets sale_discount_amount + * * @return string */ public function getSaleDiscountAmount() @@ -494,7 +607,9 @@ public function getSaleDiscountAmount() /** * Sets sale_discount_amount + * * @param string $sale_discount_amount Reserved for DocuSign use only. + * * @return $this */ public function setSaleDiscountAmount($sale_discount_amount) @@ -506,6 +621,7 @@ public function setSaleDiscountAmount($sale_discount_amount) /** * Gets sale_discount_fixed_amount + * * @return string */ public function getSaleDiscountFixedAmount() @@ -515,7 +631,9 @@ public function getSaleDiscountFixedAmount() /** * Sets sale_discount_fixed_amount + * * @param string $sale_discount_fixed_amount Reserved for DocuSign use only. + * * @return $this */ public function setSaleDiscountFixedAmount($sale_discount_fixed_amount) @@ -527,6 +645,7 @@ public function setSaleDiscountFixedAmount($sale_discount_fixed_amount) /** * Gets sale_discount_percent + * * @return string */ public function getSaleDiscountPercent() @@ -536,7 +655,9 @@ public function getSaleDiscountPercent() /** * Sets sale_discount_percent + * * @param string $sale_discount_percent Reserved for DocuSign use only. + * * @return $this */ public function setSaleDiscountPercent($sale_discount_percent) @@ -548,6 +669,7 @@ public function setSaleDiscountPercent($sale_discount_percent) /** * Gets sale_discount_periods + * * @return string */ public function getSaleDiscountPeriods() @@ -557,7 +679,9 @@ public function getSaleDiscountPeriods() /** * Sets sale_discount_periods + * * @param string $sale_discount_periods Reserved for DocuSign use only. + * * @return $this */ public function setSaleDiscountPeriods($sale_discount_periods) @@ -569,6 +693,7 @@ public function setSaleDiscountPeriods($sale_discount_periods) /** * Gets sale_discount_seat_price_override + * * @return string */ public function getSaleDiscountSeatPriceOverride() @@ -578,7 +703,9 @@ public function getSaleDiscountSeatPriceOverride() /** * Sets sale_discount_seat_price_override + * * @param string $sale_discount_seat_price_override Reserved for DocuSign use only. + * * @return $this */ public function setSaleDiscountSeatPriceOverride($sale_discount_seat_price_override) @@ -590,6 +717,7 @@ public function setSaleDiscountSeatPriceOverride($sale_discount_seat_price_overr /** * Gets shopper_id + * * @return string */ public function getShopperId() @@ -599,7 +727,9 @@ public function getShopperId() /** * Sets shopper_id + * * @param string $shopper_id + * * @return $this */ public function setShopperId($shopper_id) @@ -610,7 +740,9 @@ public function setShopperId($shopper_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -620,7 +752,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -630,8 +764,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -645,7 +781,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -655,16 +793,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Reminders.php b/src/Model/Reminders.php index cfe7a3f5..7046d15a 100644 --- a/src/Model/Reminders.php +++ b/src/Model/Reminders.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Reminders Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Reminders implements ArrayAccess +class Reminders implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'reminders'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,41 @@ class Reminders implements ArrayAccess 'reminder_frequency' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'reminder_delay' => null, + 'reminder_enabled' => null, + 'reminder_frequency' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -75,9 +106,9 @@ public static function swaggerTypes() 'reminder_frequency' => 'reminderFrequency' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -86,9 +117,9 @@ public static function swaggerTypes() 'reminder_frequency' => 'setReminderFrequency' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -97,34 +128,63 @@ public static function swaggerTypes() 'reminder_frequency' => 'getReminderFrequency' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -134,30 +194,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets reminder_delay + * * @return string */ public function getReminderDelay() @@ -167,7 +229,9 @@ public function getReminderDelay() /** * Sets reminder_delay + * * @param string $reminder_delay An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. + * * @return $this */ public function setReminderDelay($reminder_delay) @@ -179,6 +243,7 @@ public function setReminderDelay($reminder_delay) /** * Gets reminder_enabled + * * @return string */ public function getReminderEnabled() @@ -188,7 +253,9 @@ public function getReminderEnabled() /** * Sets reminder_enabled + * * @param string $reminder_enabled When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. + * * @return $this */ public function setReminderEnabled($reminder_enabled) @@ -200,6 +267,7 @@ public function setReminderEnabled($reminder_enabled) /** * Gets reminder_frequency + * * @return string */ public function getReminderFrequency() @@ -209,7 +277,9 @@ public function getReminderFrequency() /** * Sets reminder_frequency + * * @param string $reminder_frequency An interger that sets the interval, in days, between reminder emails. + * * @return $this */ public function setReminderFrequency($reminder_frequency) @@ -220,7 +290,9 @@ public function setReminderFrequency($reminder_frequency) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -230,7 +302,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -240,8 +314,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -255,7 +331,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -265,16 +343,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ResourceInformation.php b/src/Model/ResourceInformation.php index ccabb5bb..f7d9cd30 100644 --- a/src/Model/ResourceInformation.php +++ b/src/Model/ResourceInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ResourceInformation Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ResourceInformation implements ArrayAccess +class ResourceInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'resourceInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'resources' => '\DocuSign\eSign\Model\NameValue[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'resources' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'resources' => 'resources' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'resources' => 'setResources' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'resources' => 'getResources' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets resources + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getResources() @@ -156,7 +216,9 @@ public function getResources() /** * Sets resources + * * @param \DocuSign\eSign\Model\NameValue[] $resources + * * @return $this */ public function setResources($resources) @@ -167,7 +229,9 @@ public function setResources($resources) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ReturnUrlRequest.php b/src/Model/ReturnUrlRequest.php index 25eb090d..25bbdfd0 100644 --- a/src/Model/ReturnUrlRequest.php +++ b/src/Model/ReturnUrlRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ReturnUrlRequest Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ReturnUrlRequest implements ArrayAccess +class ReturnUrlRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'returnUrlRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'return_url' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'return_url' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'return_url' => 'returnUrl' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'return_url' => 'setReturnUrl' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'return_url' => 'getReturnUrl' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets return_url + * * @return string */ public function getReturnUrl() @@ -156,7 +216,9 @@ public function getReturnUrl() /** * Sets return_url + * * @param string $return_url Identifies the return point after sending the envelope. DocuSign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action). + * * @return $this */ public function setReturnUrl($return_url) @@ -167,7 +229,9 @@ public function setReturnUrl($return_url) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SealIdentifier.php b/src/Model/SealIdentifier.php index 0a22556d..18cd8288 100644 --- a/src/Model/SealIdentifier.php +++ b/src/Model/SealIdentifier.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SealIdentifier Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SealIdentifier implements ArrayAccess +class SealIdentifier implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'sealIdentifier'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class SealIdentifier implements ArrayAccess 'seal_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'seal_display_name' => null, + 'seal_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'seal_name' => 'sealName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'seal_name' => 'setSealName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'seal_name' => 'getSealName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets seal_display_name + * * @return string */ public function getSealDisplayName() @@ -161,7 +222,9 @@ public function getSealDisplayName() /** * Sets seal_display_name + * * @param string $seal_display_name + * * @return $this */ public function setSealDisplayName($seal_display_name) @@ -173,6 +236,7 @@ public function setSealDisplayName($seal_display_name) /** * Gets seal_name + * * @return string */ public function getSealName() @@ -182,7 +246,9 @@ public function getSealName() /** * Sets seal_name + * * @param string $seal_name + * * @return $this */ public function setSealName($seal_name) @@ -193,7 +259,9 @@ public function setSealName($seal_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SealSign.php b/src/Model/SealSign.php index 4d0ccfb6..18434353 100644 --- a/src/Model/SealSign.php +++ b/src/Model/SealSign.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SealSign Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SealSign implements ArrayAccess +class SealSign implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'sealSign'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -77,6 +80,7 @@ class SealSign implements ArrayAccess 'id_check_configuration_name' => 'string', 'id_check_configuration_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'locked_recipient_phone_auth_editable' => 'string', 'locked_recipient_sms_editable' => 'string', @@ -111,13 +115,94 @@ class SealSign implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'allow_system_override_for_locked_recipient' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'note' => null, + 'note_metadata' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_signature_providers' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'tabs' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -144,6 +229,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_configuration_name_metadata' => 'idCheckConfigurationNameMetadata', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'locked_recipient_phone_auth_editable' => 'lockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable' => 'lockedRecipientSmsEditable', @@ -178,9 +264,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -207,6 +293,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'setIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'locked_recipient_phone_auth_editable' => 'setLockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable' => 'setLockedRecipientSmsEditable', @@ -241,9 +328,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -270,6 +357,7 @@ public static function swaggerTypes() 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_configuration_name_metadata' => 'getIdCheckConfigurationNameMetadata', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'locked_recipient_phone_auth_editable' => 'getLockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable' => 'getLockedRecipientSmsEditable', @@ -304,34 +392,63 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -358,6 +475,7 @@ public function __construct(array $data = null) $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_configuration_name_metadata'] = isset($data['id_check_configuration_name_metadata']) ? $data['id_check_configuration_name_metadata'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['identity_verification'] = isset($data['identity_verification']) ? $data['identity_verification'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; $this->container['locked_recipient_phone_auth_editable'] = isset($data['locked_recipient_phone_auth_editable']) ? $data['locked_recipient_phone_auth_editable'] : null; $this->container['locked_recipient_sms_editable'] = isset($data['locked_recipient_sms_editable']) ? $data['locked_recipient_sms_editable'] : null; @@ -393,30 +511,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -426,7 +546,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -438,6 +560,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -447,7 +570,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -459,6 +584,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -468,7 +594,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -480,6 +608,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -489,7 +618,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -501,6 +632,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -510,7 +642,9 @@ public function getClientUserId() /** * 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) @@ -522,6 +656,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -531,7 +666,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -543,6 +680,7 @@ public function setCompletedCount($completed_count) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -552,7 +690,9 @@ public function getCustomFields() /** * 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) @@ -564,6 +704,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -573,7 +714,9 @@ public function getDeclinedDateTime() /** * 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) @@ -585,6 +728,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -594,7 +738,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -606,6 +752,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -615,7 +762,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -627,6 +776,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -636,7 +786,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -648,6 +800,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -657,7 +810,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -669,6 +824,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -678,7 +834,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -690,6 +848,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -699,7 +858,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -711,6 +872,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -720,7 +882,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -732,6 +896,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -741,7 +906,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -753,6 +920,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -762,7 +930,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -774,6 +944,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -783,7 +954,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -795,6 +968,7 @@ public function setErrorDetails($error_details) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -804,7 +978,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -816,6 +992,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -825,7 +1002,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -837,6 +1016,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -846,7 +1026,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -858,6 +1040,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -867,7 +1050,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -879,6 +1064,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -888,7 +1074,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -898,8 +1086,33 @@ public function setIdCheckInformationInput($id_check_information_input) return $this; } + /** + * Gets identity_verification + * + * @return \DocuSign\eSign\Model\RecipientIdentityVerification + */ + public function getIdentityVerification() + { + return $this->container['identity_verification']; + } + + /** + * Sets identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * + * @return $this + */ + public function setIdentityVerification($identity_verification) + { + $this->container['identity_verification'] = $identity_verification; + + return $this; + } + /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -909,7 +1122,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -921,6 +1136,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -930,7 +1146,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -942,6 +1160,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -951,7 +1170,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -963,6 +1184,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -972,7 +1194,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -984,6 +1208,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -993,7 +1218,9 @@ public function getNote() /** * 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) @@ -1005,6 +1232,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1014,7 +1242,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1026,6 +1256,7 @@ public function setNoteMetadata($note_metadata) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1035,7 +1266,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1047,6 +1280,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1056,7 +1290,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1068,6 +1304,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1077,7 +1314,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1089,6 +1328,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1098,7 +1338,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1110,6 +1352,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1119,7 +1362,9 @@ public function getRecipientId() /** * 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) @@ -1131,6 +1376,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1140,7 +1386,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1152,6 +1400,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -1161,7 +1410,9 @@ public function getRecipientSignatureProviders() /** * Sets recipient_signature_providers + * * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * * @return $this */ public function setRecipientSignatureProviders($recipient_signature_providers) @@ -1173,6 +1424,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1182,7 +1434,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1194,6 +1448,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1203,7 +1458,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1215,6 +1472,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1224,7 +1482,9 @@ public function getRequireIdLookup() /** * 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) @@ -1236,6 +1496,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1245,7 +1506,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1257,6 +1520,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1266,7 +1530,9 @@ public function getRoleName() /** * 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) @@ -1278,6 +1544,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1287,7 +1554,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -1299,6 +1568,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -1308,7 +1578,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -1320,6 +1592,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1329,7 +1602,9 @@ public function getSentDateTime() /** * 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) @@ -1341,6 +1616,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1350,7 +1626,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -1362,6 +1640,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1371,7 +1650,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -1383,6 +1664,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1392,7 +1674,9 @@ public function getSocialAuthentications() /** * 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) @@ -1404,6 +1688,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1413,7 +1698,9 @@ public function getStatus() /** * 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) @@ -1425,6 +1712,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -1434,7 +1722,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -1446,6 +1736,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -1455,7 +1746,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -1467,6 +1760,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -1476,7 +1770,9 @@ public function getTabs() /** * Sets tabs - * @param \DocuSign\eSign\Model\Tabs $tabs + * + * @param \DocuSign\eSign\Model\Tabs $tabs tabs + * * @return $this */ public function setTabs($tabs) @@ -1488,6 +1784,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1497,7 +1794,9 @@ public function getTemplateLocked() /** * 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) @@ -1509,6 +1808,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1518,7 +1818,9 @@ public function getTemplateRequired() /** * 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) @@ -1530,6 +1832,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1539,7 +1842,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1551,6 +1856,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1560,7 +1866,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1571,7 +1879,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1581,7 +1891,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1591,8 +1903,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1606,7 +1920,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1616,16 +1932,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SeatDiscount.php b/src/Model/SeatDiscount.php index 7f19a391..4624fad7 100644 --- a/src/Model/SeatDiscount.php +++ b/src/Model/SeatDiscount.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SeatDiscount Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SeatDiscount implements ArrayAccess +class SeatDiscount implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'seatDiscount'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class SeatDiscount implements ArrayAccess 'end_seat_count' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'begin_seat_count' => null, + 'discount_percent' => null, + 'end_seat_count' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'end_seat_count' => 'endSeatCount' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'end_seat_count' => 'setEndSeatCount' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'end_seat_count' => 'getEndSeatCount' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets begin_seat_count + * * @return string */ public function getBeginSeatCount() @@ -166,7 +228,9 @@ public function getBeginSeatCount() /** * Sets begin_seat_count + * * @param string $begin_seat_count Reserved: TBD + * * @return $this */ public function setBeginSeatCount($begin_seat_count) @@ -178,6 +242,7 @@ public function setBeginSeatCount($begin_seat_count) /** * Gets discount_percent + * * @return string */ public function getDiscountPercent() @@ -187,7 +252,9 @@ public function getDiscountPercent() /** * Sets discount_percent + * * @param string $discount_percent + * * @return $this */ public function setDiscountPercent($discount_percent) @@ -199,6 +266,7 @@ public function setDiscountPercent($discount_percent) /** * Gets end_seat_count + * * @return string */ public function getEndSeatCount() @@ -208,7 +276,9 @@ public function getEndSeatCount() /** * Sets end_seat_count + * * @param string $end_seat_count Reserved: TBD + * * @return $this */ public function setEndSeatCount($end_seat_count) @@ -219,7 +289,9 @@ public function setEndSeatCount($end_seat_count) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SenderEmailNotifications.php b/src/Model/SenderEmailNotifications.php index 2d8dbffc..4b87d0ea 100644 --- a/src/Model/SenderEmailNotifications.php +++ b/src/Model/SenderEmailNotifications.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SenderEmailNotifications Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SenderEmailNotifications implements ArrayAccess +class SenderEmailNotifications implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'senderEmailNotifications'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class SenderEmailNotifications implements ArrayAccess 'withdrawn_consent' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'changed_signer' => null, + 'comments_only_private_and_mention' => null, + 'comments_receive_all' => null, + 'delivery_failed' => null, + 'envelope_complete' => null, + 'offline_signing_failed' => null, + 'purge_documents' => null, + 'recipient_viewed' => null, + 'sender_envelope_declined' => null, + 'withdrawn_consent' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'withdrawn_consent' => 'withdrawnConsent' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'withdrawn_consent' => 'setWithdrawnConsent' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'withdrawn_consent' => 'getWithdrawnConsent' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets changed_signer + * * @return string */ public function getChangedSigner() @@ -201,7 +270,9 @@ public function getChangedSigner() /** * Sets changed_signer + * * @param string $changed_signer When set to **true**, the sender receives notification if the signer changes. + * * @return $this */ public function setChangedSigner($changed_signer) @@ -213,6 +284,7 @@ public function setChangedSigner($changed_signer) /** * Gets comments_only_private_and_mention + * * @return string */ public function getCommentsOnlyPrivateAndMention() @@ -222,7 +294,9 @@ public function getCommentsOnlyPrivateAndMention() /** * Sets comments_only_private_and_mention + * * @param string $comments_only_private_and_mention + * * @return $this */ public function setCommentsOnlyPrivateAndMention($comments_only_private_and_mention) @@ -234,6 +308,7 @@ public function setCommentsOnlyPrivateAndMention($comments_only_private_and_ment /** * Gets comments_receive_all + * * @return string */ public function getCommentsReceiveAll() @@ -243,7 +318,9 @@ public function getCommentsReceiveAll() /** * Sets comments_receive_all + * * @param string $comments_receive_all + * * @return $this */ public function setCommentsReceiveAll($comments_receive_all) @@ -255,6 +332,7 @@ public function setCommentsReceiveAll($comments_receive_all) /** * Gets delivery_failed + * * @return string */ public function getDeliveryFailed() @@ -264,7 +342,9 @@ public function getDeliveryFailed() /** * Sets delivery_failed + * * @param string $delivery_failed When set to **true**, the sender receives notification if the delivery of the envelope fails. + * * @return $this */ public function setDeliveryFailed($delivery_failed) @@ -276,6 +356,7 @@ public function setDeliveryFailed($delivery_failed) /** * Gets envelope_complete + * * @return string */ public function getEnvelopeComplete() @@ -285,7 +366,9 @@ public function getEnvelopeComplete() /** * Sets envelope_complete + * * @param string $envelope_complete When set to **true**, the user receives notification that the envelope has been completed. + * * @return $this */ public function setEnvelopeComplete($envelope_complete) @@ -297,6 +380,7 @@ public function setEnvelopeComplete($envelope_complete) /** * Gets offline_signing_failed + * * @return string */ public function getOfflineSigningFailed() @@ -306,7 +390,9 @@ public function getOfflineSigningFailed() /** * Sets offline_signing_failed + * * @param string $offline_signing_failed When set to **true**, the user receives notification if the offline signing failed. + * * @return $this */ public function setOfflineSigningFailed($offline_signing_failed) @@ -318,6 +404,7 @@ public function setOfflineSigningFailed($offline_signing_failed) /** * Gets purge_documents + * * @return string */ public function getPurgeDocuments() @@ -327,7 +414,9 @@ public function getPurgeDocuments() /** * Sets purge_documents + * * @param string $purge_documents + * * @return $this */ public function setPurgeDocuments($purge_documents) @@ -339,6 +428,7 @@ public function setPurgeDocuments($purge_documents) /** * Gets recipient_viewed + * * @return string */ public function getRecipientViewed() @@ -348,7 +438,9 @@ public function getRecipientViewed() /** * Sets recipient_viewed + * * @param string $recipient_viewed When set to **true**, the sender receives notification that the recipient viewed the enveloper. + * * @return $this */ public function setRecipientViewed($recipient_viewed) @@ -360,6 +452,7 @@ public function setRecipientViewed($recipient_viewed) /** * Gets sender_envelope_declined + * * @return string */ public function getSenderEnvelopeDeclined() @@ -369,7 +462,9 @@ public function getSenderEnvelopeDeclined() /** * Sets sender_envelope_declined + * * @param string $sender_envelope_declined + * * @return $this */ public function setSenderEnvelopeDeclined($sender_envelope_declined) @@ -381,6 +476,7 @@ public function setSenderEnvelopeDeclined($sender_envelope_declined) /** * Gets withdrawn_consent + * * @return string */ public function getWithdrawnConsent() @@ -390,7 +486,9 @@ public function getWithdrawnConsent() /** * Sets withdrawn_consent + * * @param string $withdrawn_consent When set to **true**, the user receives notification if consent is withdrawn. + * * @return $this */ public function setWithdrawnConsent($withdrawn_consent) @@ -401,7 +499,9 @@ public function setWithdrawnConsent($withdrawn_consent) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ServerTemplate.php b/src/Model/ServerTemplate.php index 5bec2bc1..ed24d147 100644 --- a/src/Model/ServerTemplate.php +++ b/src/Model/ServerTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ServerTemplate Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ServerTemplate implements ArrayAccess +class ServerTemplate implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'serverTemplate'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class ServerTemplate implements ArrayAccess 'template_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'sequence' => null, + 'template_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'template_id' => 'templateId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'template_id' => 'setTemplateId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'template_id' => 'getTemplateId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets sequence + * * @return string */ public function getSequence() @@ -161,7 +222,9 @@ public function getSequence() /** * Sets sequence + * * @param string $sequence + * * @return $this */ public function setSequence($sequence) @@ -173,6 +236,7 @@ public function setSequence($sequence) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -182,7 +246,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -193,7 +259,9 @@ public function setTemplateId($template_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ServiceInformation.php b/src/Model/ServiceInformation.php index c860d120..9e643c41 100644 --- a/src/Model/ServiceInformation.php +++ b/src/Model/ServiceInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ServiceInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ServiceInformation implements ArrayAccess +class ServiceInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'serviceInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class ServiceInformation implements ArrayAccess 'service_versions' => '\DocuSign\eSign\Model\ServiceVersion[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'build_branch' => null, + 'build_branch_deployed_date_time' => null, + 'build_sha' => null, + 'build_version' => null, + 'linked_sites' => null, + 'service_versions' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'service_versions' => 'serviceVersions' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'service_versions' => 'setServiceVersions' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'service_versions' => 'getServiceVersions' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets build_branch + * * @return string */ public function getBuildBranch() @@ -181,7 +246,9 @@ public function getBuildBranch() /** * Sets build_branch + * * @param string $build_branch Reserved: TBD + * * @return $this */ public function setBuildBranch($build_branch) @@ -193,6 +260,7 @@ public function setBuildBranch($build_branch) /** * Gets build_branch_deployed_date_time + * * @return string */ public function getBuildBranchDeployedDateTime() @@ -202,7 +270,9 @@ public function getBuildBranchDeployedDateTime() /** * Sets build_branch_deployed_date_time + * * @param string $build_branch_deployed_date_time Reserved: TBD + * * @return $this */ public function setBuildBranchDeployedDateTime($build_branch_deployed_date_time) @@ -214,6 +284,7 @@ public function setBuildBranchDeployedDateTime($build_branch_deployed_date_time) /** * Gets build_sha + * * @return string */ public function getBuildSha() @@ -223,7 +294,9 @@ public function getBuildSha() /** * Sets build_sha + * * @param string $build_sha Reserved: TBD + * * @return $this */ public function setBuildSha($build_sha) @@ -235,6 +308,7 @@ public function setBuildSha($build_sha) /** * Gets build_version + * * @return string */ public function getBuildVersion() @@ -244,7 +318,9 @@ public function getBuildVersion() /** * Sets build_version + * * @param string $build_version Reserved: TBD + * * @return $this */ public function setBuildVersion($build_version) @@ -256,6 +332,7 @@ public function setBuildVersion($build_version) /** * Gets linked_sites + * * @return string[] */ public function getLinkedSites() @@ -265,7 +342,9 @@ public function getLinkedSites() /** * Sets linked_sites + * * @param string[] $linked_sites + * * @return $this */ public function setLinkedSites($linked_sites) @@ -277,6 +356,7 @@ public function setLinkedSites($linked_sites) /** * Gets service_versions + * * @return \DocuSign\eSign\Model\ServiceVersion[] */ public function getServiceVersions() @@ -286,7 +366,9 @@ public function getServiceVersions() /** * Sets service_versions + * * @param \DocuSign\eSign\Model\ServiceVersion[] $service_versions + * * @return $this */ public function setServiceVersions($service_versions) @@ -297,7 +379,9 @@ public function setServiceVersions($service_versions) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ServiceVersion.php b/src/Model/ServiceVersion.php index 9c335208..ffc83e0f 100644 --- a/src/Model/ServiceVersion.php +++ b/src/Model/ServiceVersion.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ServiceVersion Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ServiceVersion implements ArrayAccess +class ServiceVersion implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'serviceVersion'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class ServiceVersion implements ArrayAccess 'version_url' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'version' => null, + 'version_url' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'version_url' => 'versionUrl' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'version_url' => 'setVersionUrl' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'version_url' => 'getVersionUrl' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets version + * * @return string */ public function getVersion() @@ -161,7 +222,9 @@ public function getVersion() /** * Sets version + * * @param string $version The version of the rest API. + * * @return $this */ public function setVersion($version) @@ -173,6 +236,7 @@ public function setVersion($version) /** * Gets version_url + * * @return string */ public function getVersionUrl() @@ -182,7 +246,9 @@ public function getVersionUrl() /** * Sets version_url + * * @param string $version_url + * * @return $this */ public function setVersionUrl($version_url) @@ -193,7 +259,9 @@ public function setVersionUrl($version_url) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SettingsMetadata.php b/src/Model/SettingsMetadata.php index cbf29d1c..17dd2b12 100644 --- a/src/Model/SettingsMetadata.php +++ b/src/Model/SettingsMetadata.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SettingsMetadata Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SettingsMetadata implements ArrayAccess +class SettingsMetadata implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'settingsMetadata'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,44 @@ class SettingsMetadata implements ArrayAccess 'ui_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'is21_cfr_part11' => null, + 'options' => null, + 'rights' => null, + 'ui_hint' => null, + 'ui_order' => null, + 'ui_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'ui_type' => 'uiType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'ui_type' => 'setUiType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,63 @@ public static function swaggerTypes() 'ui_type' => 'getUiType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -148,30 +211,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -181,7 +246,9 @@ public function getIs21CfrPart11() /** * Sets is21_cfr_part11 + * * @param string $is21_cfr_part11 When set to **true**, indicates that this module is enabled on the account. + * * @return $this */ public function setIs21CfrPart11($is21_cfr_part11) @@ -193,6 +260,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets options + * * @return string[] */ public function getOptions() @@ -202,7 +270,9 @@ public function getOptions() /** * Sets options + * * @param string[] $options + * * @return $this */ public function setOptions($options) @@ -214,6 +284,7 @@ public function setOptions($options) /** * Gets rights + * * @return string */ public function getRights() @@ -223,7 +294,9 @@ public function getRights() /** * Sets rights + * * @param string $rights + * * @return $this */ public function setRights($rights) @@ -235,6 +308,7 @@ public function setRights($rights) /** * Gets ui_hint + * * @return string */ public function getUiHint() @@ -244,7 +318,9 @@ public function getUiHint() /** * Sets ui_hint + * * @param string $ui_hint + * * @return $this */ public function setUiHint($ui_hint) @@ -256,6 +332,7 @@ public function setUiHint($ui_hint) /** * Gets ui_order + * * @return string */ public function getUiOrder() @@ -265,7 +342,9 @@ public function getUiOrder() /** * Sets ui_order + * * @param string $ui_order + * * @return $this */ public function setUiOrder($ui_order) @@ -277,6 +356,7 @@ public function setUiOrder($ui_order) /** * Gets ui_type + * * @return string */ public function getUiType() @@ -286,7 +366,9 @@ public function getUiType() /** * Sets ui_type + * * @param string $ui_type + * * @return $this */ public function setUiType($ui_type) @@ -297,7 +379,9 @@ public function setUiType($ui_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -307,7 +391,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -317,8 +403,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -332,7 +420,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -342,16 +432,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SharedItem.php b/src/Model/SharedItem.php index cac5d093..d1898f44 100644 --- a/src/Model/SharedItem.php +++ b/src/Model/SharedItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SharedItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SharedItem implements ArrayAccess +class SharedItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'sharedItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class SharedItem implements ArrayAccess 'user' => '\DocuSign\eSign\Model\UserInfo' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'shared' => null, + 'user' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'user' => 'user' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'user' => 'setUser' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'user' => 'getUser' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -166,7 +228,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -178,6 +242,7 @@ public function setErrorDetails($error_details) /** * Gets shared + * * @return string */ public function getShared() @@ -187,7 +252,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -199,6 +266,7 @@ public function setShared($shared) /** * Gets user + * * @return \DocuSign\eSign\Model\UserInfo */ public function getUser() @@ -208,7 +276,9 @@ public function getUser() /** * Sets user - * @param \DocuSign\eSign\Model\UserInfo $user + * + * @param \DocuSign\eSign\Model\UserInfo $user user + * * @return $this */ public function setUser($user) @@ -219,7 +289,9 @@ public function setUser($user) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SignHere.php b/src/Model/SignHere.php index 0f574824..913d9cc5 100644 --- a/src/Model/SignHere.php +++ b/src/Model/SignHere.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SignHere Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SignHere implements ArrayAccess +class SignHere implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signHere'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -136,13 +139,118 @@ class SignHere implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'is_seal_sign_tab' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'optional' => null, + 'optional_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'scale_value' => null, + 'scale_value_metadata' => null, + 'smart_contract_information' => null, + 'stamp' => null, + 'stamp_type' => null, + 'stamp_type_metadata' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -228,9 +336,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -316,9 +424,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -404,34 +512,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -518,30 +655,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -551,7 +690,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -563,6 +704,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -572,7 +714,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -584,6 +728,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -593,7 +738,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -605,6 +752,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -614,7 +762,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -626,6 +776,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -635,7 +786,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -647,6 +800,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -656,7 +810,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -668,6 +824,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -677,7 +834,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -689,6 +848,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -698,7 +858,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -710,6 +872,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -719,7 +882,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -731,6 +896,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -740,7 +906,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -752,6 +920,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -761,7 +930,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -773,6 +944,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -782,7 +954,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -794,6 +968,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -803,7 +978,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -815,6 +992,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -824,7 +1002,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -836,6 +1016,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -845,7 +1026,9 @@ public function getAnchorUnits() /** * 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) @@ -857,6 +1040,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -866,7 +1050,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -878,6 +1064,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -887,7 +1074,9 @@ public function getAnchorXOffset() /** * 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) @@ -899,6 +1088,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -908,7 +1098,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -920,6 +1112,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -929,7 +1122,9 @@ public function getAnchorYOffset() /** * 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) @@ -941,6 +1136,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -950,7 +1146,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -962,6 +1160,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -971,7 +1170,9 @@ public function getConditionalParentLabel() /** * 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) @@ -983,6 +1184,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -992,7 +1194,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1004,6 +1208,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1013,7 +1218,9 @@ public function getConditionalParentValue() /** * 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) @@ -1025,6 +1232,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1034,7 +1242,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1046,6 +1256,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1055,7 +1266,9 @@ public function getCustomTabId() /** * 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) @@ -1067,6 +1280,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1076,7 +1290,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1088,6 +1304,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1097,7 +1314,9 @@ public function getDocumentId() /** * 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) @@ -1109,6 +1328,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1118,7 +1338,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1130,6 +1352,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1139,7 +1362,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1151,6 +1376,7 @@ public function setErrorDetails($error_details) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1160,7 +1386,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1172,6 +1400,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1181,7 +1410,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1193,6 +1424,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1202,7 +1434,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1214,6 +1448,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1223,7 +1458,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1235,6 +1472,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1244,7 +1482,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1256,6 +1496,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1265,7 +1506,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1277,6 +1520,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1286,7 +1530,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1298,6 +1544,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1307,7 +1554,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1319,6 +1568,7 @@ public function setHeightMetadata($height_metadata) /** * Gets is_seal_sign_tab + * * @return string */ public function getIsSealSignTab() @@ -1328,7 +1578,9 @@ public function getIsSealSignTab() /** * Sets is_seal_sign_tab + * * @param string $is_seal_sign_tab + * * @return $this */ public function setIsSealSignTab($is_seal_sign_tab) @@ -1340,6 +1592,7 @@ public function setIsSealSignTab($is_seal_sign_tab) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1349,7 +1602,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1361,6 +1616,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1370,7 +1626,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1382,6 +1640,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1391,7 +1650,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -1403,6 +1664,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1412,7 +1674,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1424,6 +1688,7 @@ public function setNameMetadata($name_metadata) /** * Gets optional + * * @return string */ public function getOptional() @@ -1433,7 +1698,9 @@ public function getOptional() /** * Sets optional + * * @param string $optional + * * @return $this */ public function setOptional($optional) @@ -1445,6 +1712,7 @@ public function setOptional($optional) /** * Gets optional_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOptionalMetadata() @@ -1454,7 +1722,9 @@ public function getOptionalMetadata() /** * Sets optional_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $optional_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $optional_metadata optional_metadata + * * @return $this */ public function setOptionalMetadata($optional_metadata) @@ -1466,6 +1736,7 @@ public function setOptionalMetadata($optional_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1475,7 +1746,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1487,6 +1760,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1496,7 +1770,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1508,6 +1784,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1517,7 +1794,9 @@ public function getRecipientId() /** * 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) @@ -1529,6 +1808,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1538,7 +1818,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1550,6 +1832,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1559,7 +1842,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1571,6 +1856,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1580,7 +1866,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1592,6 +1880,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets scale_value + * * @return string */ public function getScaleValue() @@ -1601,7 +1890,9 @@ public function getScaleValue() /** * Sets scale_value + * * @param string $scale_value + * * @return $this */ public function setScaleValue($scale_value) @@ -1613,6 +1904,7 @@ public function setScaleValue($scale_value) /** * Gets scale_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getScaleValueMetadata() @@ -1622,7 +1914,9 @@ public function getScaleValueMetadata() /** * Sets scale_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $scale_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $scale_value_metadata scale_value_metadata + * * @return $this */ public function setScaleValueMetadata($scale_value_metadata) @@ -1634,6 +1928,7 @@ public function setScaleValueMetadata($scale_value_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1643,7 +1938,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1655,6 +1952,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets stamp + * * @return \DocuSign\eSign\Model\Stamp */ public function getStamp() @@ -1664,7 +1962,9 @@ public function getStamp() /** * Sets stamp - * @param \DocuSign\eSign\Model\Stamp $stamp + * + * @param \DocuSign\eSign\Model\Stamp $stamp stamp + * * @return $this */ public function setStamp($stamp) @@ -1676,6 +1976,7 @@ public function setStamp($stamp) /** * Gets stamp_type + * * @return string */ public function getStampType() @@ -1685,7 +1986,9 @@ public function getStampType() /** * Sets stamp_type + * * @param string $stamp_type + * * @return $this */ public function setStampType($stamp_type) @@ -1697,6 +2000,7 @@ public function setStampType($stamp_type) /** * Gets stamp_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStampTypeMetadata() @@ -1706,7 +2010,9 @@ public function getStampTypeMetadata() /** * Sets stamp_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $stamp_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $stamp_type_metadata stamp_type_metadata + * * @return $this */ public function setStampTypeMetadata($stamp_type_metadata) @@ -1718,6 +2024,7 @@ public function setStampTypeMetadata($stamp_type_metadata) /** * Gets status + * * @return string */ public function getStatus() @@ -1727,7 +2034,9 @@ public function getStatus() /** * 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) @@ -1739,6 +2048,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1748,7 +2058,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1760,6 +2072,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1769,7 +2082,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1781,6 +2096,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1790,7 +2106,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1802,6 +2120,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1811,7 +2130,9 @@ public function getTabId() /** * 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) @@ -1823,6 +2144,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1832,7 +2154,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1844,6 +2168,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1853,7 +2178,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1865,6 +2192,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1874,7 +2202,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1886,6 +2216,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1895,7 +2226,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1907,6 +2240,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1916,7 +2250,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -1928,6 +2264,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -1937,7 +2274,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -1949,6 +2288,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -1958,7 +2298,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -1970,6 +2312,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1979,7 +2322,9 @@ public function getTemplateLocked() /** * 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) @@ -1991,6 +2336,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2000,7 +2346,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2012,6 +2360,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2021,7 +2370,9 @@ public function getTemplateRequired() /** * 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) @@ -2033,6 +2384,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2042,7 +2394,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2054,6 +2408,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2063,7 +2418,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2075,6 +2432,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2084,7 +2442,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2096,6 +2456,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2105,7 +2466,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2117,6 +2480,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2126,7 +2490,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2138,6 +2504,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2147,7 +2514,9 @@ public function getXPosition() /** * 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) @@ -2159,6 +2528,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2168,7 +2538,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2180,6 +2552,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2189,7 +2562,9 @@ public function getYPosition() /** * 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) @@ -2201,6 +2576,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2210,7 +2586,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2221,7 +2599,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2231,7 +2611,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2241,8 +2623,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2256,7 +2640,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2266,16 +2652,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SignatureProviderRequiredOption.php b/src/Model/SignatureProviderRequiredOption.php index c7d8ad33..e5dea5b6 100644 --- a/src/Model/SignatureProviderRequiredOption.php +++ b/src/Model/SignatureProviderRequiredOption.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SignatureProviderRequiredOption Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SignatureProviderRequiredOption implements ArrayAccess +class SignatureProviderRequiredOption implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signatureProviderRequiredOption'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class SignatureProviderRequiredOption implements ArrayAccess 'signer_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'required_signature_provider_option_ids' => null, + 'signer_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'signer_type' => 'signerType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'signer_type' => 'setSignerType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'signer_type' => 'getSignerType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets required_signature_provider_option_ids + * * @return string[] */ public function getRequiredSignatureProviderOptionIds() @@ -161,7 +222,9 @@ public function getRequiredSignatureProviderOptionIds() /** * Sets required_signature_provider_option_ids + * * @param string[] $required_signature_provider_option_ids + * * @return $this */ public function setRequiredSignatureProviderOptionIds($required_signature_provider_option_ids) @@ -173,6 +236,7 @@ public function setRequiredSignatureProviderOptionIds($required_signature_provid /** * Gets signer_type + * * @return string */ public function getSignerType() @@ -182,7 +246,9 @@ public function getSignerType() /** * Sets signer_type + * * @param string $signer_type + * * @return $this */ public function setSignerType($signer_type) @@ -193,7 +259,9 @@ public function setSignerType($signer_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SignatureType.php b/src/Model/SignatureType.php index 10a2fc72..9dea5064 100644 --- a/src/Model/SignatureType.php +++ b/src/Model/SignatureType.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SignatureType Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SignatureType implements ArrayAccess +class SignatureType implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signatureType'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class SignatureType implements ArrayAccess 'type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'is_default' => null, + 'type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'type' => 'type' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'type' => 'setType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'type' => 'getType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets is_default + * * @return string */ public function getIsDefault() @@ -161,7 +222,9 @@ public function getIsDefault() /** * Sets is_default + * * @param string $is_default + * * @return $this */ public function setIsDefault($is_default) @@ -173,6 +236,7 @@ public function setIsDefault($is_default) /** * Gets type + * * @return string */ public function getType() @@ -182,7 +246,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -193,7 +259,9 @@ public function setType($type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Signer.php b/src/Model/Signer.php index fc0c5616..62ba9037 100644 --- a/src/Model/Signer.php +++ b/src/Model/Signer.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Signer Class Doc Comment @@ -39,24 +40,28 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Signer implements ArrayAccess +class Signer implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signer'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'access_code' => 'string', 'access_code_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'add_access_code_to_email' => 'string', + 'additional_notifications' => '\DocuSign\eSign\Model\RecipientAdditionalNotification[]', + 'additional_notifications_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'agent_can_edit_email' => 'string', 'agent_can_edit_name' => 'string', 'allow_system_override_for_locked_recipient' => 'string', @@ -144,19 +149,136 @@ class Signer implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'additional_notifications' => null, + 'additional_notifications_metadata' => null, + 'agent_can_edit_email' => null, + 'agent_can_edit_name' => null, + 'allow_system_override_for_locked_recipient' => null, + 'auto_navigation' => null, + 'bulk_recipients_uri' => null, + 'can_sign_offline' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'creation_reason' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'default_recipient' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email' => null, + 'email_metadata' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'first_name' => null, + 'first_name_metadata' => null, + 'full_name' => null, + 'full_name_metadata' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'is_bulk_recipient' => null, + 'is_bulk_recipient_metadata' => null, + 'last_name' => null, + 'last_name_metadata' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'name_metadata' => null, + 'note' => null, + 'note_metadata' => null, + 'offline_attributes' => null, + 'phone_authentication' => null, + 'proof_file' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_signature_providers' => null, + 'recipient_supplies_tabs' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'require_signer_certificate' => null, + 'require_sign_on_paper' => null, + 'require_upload_signature' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signature_info' => null, + 'signed_date_time' => null, + 'sign_in_each_location' => null, + 'sign_in_each_location_metadata' => null, + 'signing_group_id' => null, + 'signing_group_id_metadata' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'tabs' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'access_code' => 'accessCode', 'access_code_metadata' => 'accessCodeMetadata', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'additional_notifications' => 'additionalNotifications', + 'additional_notifications_metadata' => 'additionalNotificationsMetadata', 'agent_can_edit_email' => 'agentCanEditEmail', 'agent_can_edit_name' => 'agentCanEditName', 'allow_system_override_for_locked_recipient' => 'allowSystemOverrideForLockedRecipient', @@ -244,15 +366,17 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'access_code' => 'setAccessCode', 'access_code_metadata' => 'setAccessCodeMetadata', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'additional_notifications' => 'setAdditionalNotifications', + 'additional_notifications_metadata' => 'setAdditionalNotificationsMetadata', 'agent_can_edit_email' => 'setAgentCanEditEmail', 'agent_can_edit_name' => 'setAgentCanEditName', 'allow_system_override_for_locked_recipient' => 'setAllowSystemOverrideForLockedRecipient', @@ -340,15 +464,17 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'access_code' => 'getAccessCode', 'access_code_metadata' => 'getAccessCodeMetadata', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'additional_notifications' => 'getAdditionalNotifications', + 'additional_notifications_metadata' => 'getAdditionalNotificationsMetadata', 'agent_can_edit_email' => 'getAgentCanEditEmail', 'agent_can_edit_name' => 'getAgentCanEditName', 'allow_system_override_for_locked_recipient' => 'getAllowSystemOverrideForLockedRecipient', @@ -436,40 +562,71 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @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['access_code_metadata'] = isset($data['access_code_metadata']) ? $data['access_code_metadata'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['additional_notifications'] = isset($data['additional_notifications']) ? $data['additional_notifications'] : null; + $this->container['additional_notifications_metadata'] = isset($data['additional_notifications_metadata']) ? $data['additional_notifications_metadata'] : 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['allow_system_override_for_locked_recipient'] = isset($data['allow_system_override_for_locked_recipient']) ? $data['allow_system_override_for_locked_recipient'] : null; @@ -558,30 +715,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -591,7 +750,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -603,6 +764,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -612,7 +774,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -624,6 +788,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -633,7 +798,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -643,8 +810,57 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets additional_notifications + * + * @return \DocuSign\eSign\Model\RecipientAdditionalNotification[] + */ + public function getAdditionalNotifications() + { + return $this->container['additional_notifications']; + } + + /** + * Sets additional_notifications + * + * @param \DocuSign\eSign\Model\RecipientAdditionalNotification[] $additional_notifications + * + * @return $this + */ + public function setAdditionalNotifications($additional_notifications) + { + $this->container['additional_notifications'] = $additional_notifications; + + return $this; + } + + /** + * Gets additional_notifications_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getAdditionalNotificationsMetadata() + { + return $this->container['additional_notifications_metadata']; + } + + /** + * Sets additional_notifications_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $additional_notifications_metadata additional_notifications_metadata + * + * @return $this + */ + public function setAdditionalNotificationsMetadata($additional_notifications_metadata) + { + $this->container['additional_notifications_metadata'] = $additional_notifications_metadata; + + return $this; + } + /** * Gets agent_can_edit_email + * * @return string */ public function getAgentCanEditEmail() @@ -654,7 +870,9 @@ public function getAgentCanEditEmail() /** * Sets agent_can_edit_email + * * @param string $agent_can_edit_email + * * @return $this */ public function setAgentCanEditEmail($agent_can_edit_email) @@ -666,6 +884,7 @@ public function setAgentCanEditEmail($agent_can_edit_email) /** * Gets agent_can_edit_name + * * @return string */ public function getAgentCanEditName() @@ -675,7 +894,9 @@ public function getAgentCanEditName() /** * Sets agent_can_edit_name + * * @param string $agent_can_edit_name + * * @return $this */ public function setAgentCanEditName($agent_can_edit_name) @@ -687,6 +908,7 @@ public function setAgentCanEditName($agent_can_edit_name) /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -696,7 +918,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -708,6 +932,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -717,7 +942,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -729,6 +956,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets bulk_recipients_uri + * * @return string */ public function getBulkRecipientsUri() @@ -738,7 +966,9 @@ public function getBulkRecipientsUri() /** * 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) @@ -750,6 +980,7 @@ public function setBulkRecipientsUri($bulk_recipients_uri) /** * Gets can_sign_offline + * * @return string */ public function getCanSignOffline() @@ -759,7 +990,9 @@ public function getCanSignOffline() /** * 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) @@ -771,6 +1004,7 @@ public function setCanSignOffline($can_sign_offline) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -780,7 +1014,9 @@ public function getClientUserId() /** * 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) @@ -792,6 +1028,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -801,7 +1038,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -813,6 +1052,7 @@ public function setCompletedCount($completed_count) /** * Gets creation_reason + * * @return string */ public function getCreationReason() @@ -822,7 +1062,9 @@ public function getCreationReason() /** * Sets creation_reason + * * @param string $creation_reason + * * @return $this */ public function setCreationReason($creation_reason) @@ -834,6 +1076,7 @@ public function setCreationReason($creation_reason) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -843,7 +1086,9 @@ public function getCustomFields() /** * 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) @@ -855,6 +1100,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -864,7 +1110,9 @@ public function getDeclinedDateTime() /** * 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) @@ -876,6 +1124,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -885,7 +1134,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -897,6 +1148,7 @@ public function setDeclinedReason($declined_reason) /** * Gets default_recipient + * * @return string */ public function getDefaultRecipient() @@ -906,7 +1158,9 @@ public function getDefaultRecipient() /** * Sets default_recipient + * * @param string $default_recipient + * * @return $this */ public function setDefaultRecipient($default_recipient) @@ -918,6 +1172,7 @@ public function setDefaultRecipient($default_recipient) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -927,7 +1182,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -939,6 +1196,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -948,7 +1206,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -960,6 +1220,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -969,7 +1230,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -981,6 +1244,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -990,7 +1254,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -1002,6 +1268,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -1011,7 +1278,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -1023,6 +1292,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -1032,7 +1302,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -1044,6 +1316,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -1053,7 +1326,9 @@ public function getEmail() /** * Sets email + * * @param string $email Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. + * * @return $this */ public function setEmail($email) @@ -1065,6 +1340,7 @@ public function setEmail($email) /** * Gets email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailMetadata() @@ -1074,7 +1350,9 @@ public function getEmailMetadata() /** * Sets email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata email_metadata + * * @return $this */ public function setEmailMetadata($email_metadata) @@ -1086,6 +1364,7 @@ public function setEmailMetadata($email_metadata) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -1095,7 +1374,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -1107,6 +1388,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -1116,7 +1398,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -1128,6 +1412,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1137,7 +1422,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1149,6 +1436,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -1158,7 +1446,9 @@ public function getExcludedDocuments() /** * 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) @@ -1170,6 +1460,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -1179,7 +1470,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -1191,6 +1484,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -1200,7 +1494,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -1212,6 +1508,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -1221,7 +1518,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -1233,6 +1532,7 @@ public function setFirstName($first_name) /** * Gets first_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFirstNameMetadata() @@ -1242,7 +1542,9 @@ public function getFirstNameMetadata() /** * Sets first_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata first_name_metadata + * * @return $this */ public function setFirstNameMetadata($first_name_metadata) @@ -1254,6 +1556,7 @@ public function setFirstNameMetadata($first_name_metadata) /** * Gets full_name + * * @return string */ public function getFullName() @@ -1263,7 +1566,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -1275,6 +1580,7 @@ public function setFullName($full_name) /** * Gets full_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFullNameMetadata() @@ -1284,7 +1590,9 @@ public function getFullNameMetadata() /** * Sets full_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata full_name_metadata + * * @return $this */ public function setFullNameMetadata($full_name_metadata) @@ -1296,6 +1604,7 @@ public function setFullNameMetadata($full_name_metadata) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -1305,7 +1614,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -1317,6 +1628,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -1326,7 +1638,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -1338,6 +1652,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1347,7 +1662,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -1359,6 +1676,7 @@ public function setIdCheckInformationInput($id_check_information_input) /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\RecipientIdentityVerification */ public function getIdentityVerification() @@ -1368,7 +1686,9 @@ public function getIdentityVerification() /** * Sets identity_verification - * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * * @return $this */ public function setIdentityVerification($identity_verification) @@ -1380,6 +1700,7 @@ public function setIdentityVerification($identity_verification) /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1389,7 +1710,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -1401,6 +1724,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets is_bulk_recipient + * * @return string */ public function getIsBulkRecipient() @@ -1410,7 +1734,9 @@ public function getIsBulkRecipient() /** * Sets is_bulk_recipient + * * @param string $is_bulk_recipient When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient. + * * @return $this */ public function setIsBulkRecipient($is_bulk_recipient) @@ -1422,6 +1748,7 @@ public function setIsBulkRecipient($is_bulk_recipient) /** * Gets is_bulk_recipient_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIsBulkRecipientMetadata() @@ -1431,7 +1758,9 @@ public function getIsBulkRecipientMetadata() /** * Sets is_bulk_recipient_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $is_bulk_recipient_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $is_bulk_recipient_metadata is_bulk_recipient_metadata + * * @return $this */ public function setIsBulkRecipientMetadata($is_bulk_recipient_metadata) @@ -1443,6 +1772,7 @@ public function setIsBulkRecipientMetadata($is_bulk_recipient_metadata) /** * Gets last_name + * * @return string */ public function getLastName() @@ -1452,7 +1782,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -1464,6 +1796,7 @@ public function setLastName($last_name) /** * Gets last_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLastNameMetadata() @@ -1473,7 +1806,9 @@ public function getLastNameMetadata() /** * Sets last_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata last_name_metadata + * * @return $this */ public function setLastNameMetadata($last_name_metadata) @@ -1485,6 +1820,7 @@ public function setLastNameMetadata($last_name_metadata) /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -1494,7 +1830,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -1506,6 +1844,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -1515,7 +1854,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -1527,6 +1868,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -1536,7 +1878,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1548,6 +1892,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1557,7 +1902,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1569,6 +1916,7 @@ public function setNameMetadata($name_metadata) /** * Gets note + * * @return string */ public function getNote() @@ -1578,7 +1926,9 @@ public function getNote() /** * 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) @@ -1590,6 +1940,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1599,7 +1950,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1611,6 +1964,7 @@ public function setNoteMetadata($note_metadata) /** * Gets offline_attributes + * * @return \DocuSign\eSign\Model\OfflineAttributes */ public function getOfflineAttributes() @@ -1620,7 +1974,9 @@ public function getOfflineAttributes() /** * Sets offline_attributes - * @param \DocuSign\eSign\Model\OfflineAttributes $offline_attributes + * + * @param \DocuSign\eSign\Model\OfflineAttributes $offline_attributes offline_attributes + * * @return $this */ public function setOfflineAttributes($offline_attributes) @@ -1632,6 +1988,7 @@ public function setOfflineAttributes($offline_attributes) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1641,7 +1998,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1653,6 +2012,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets proof_file + * * @return \DocuSign\eSign\Model\RecipientProofFile */ public function getProofFile() @@ -1662,7 +2022,9 @@ public function getProofFile() /** * Sets proof_file - * @param \DocuSign\eSign\Model\RecipientProofFile $proof_file + * + * @param \DocuSign\eSign\Model\RecipientProofFile $proof_file proof_file + * * @return $this */ public function setProofFile($proof_file) @@ -1674,6 +2036,7 @@ public function setProofFile($proof_file) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1683,7 +2046,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1695,6 +2060,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1704,7 +2070,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1716,6 +2084,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1725,7 +2094,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1737,6 +2108,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1746,7 +2118,9 @@ public function getRecipientId() /** * 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) @@ -1758,6 +2132,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1767,7 +2142,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1779,6 +2156,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -1788,7 +2166,9 @@ public function getRecipientSignatureProviders() /** * Sets recipient_signature_providers + * * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * * @return $this */ public function setRecipientSignatureProviders($recipient_signature_providers) @@ -1800,6 +2180,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets recipient_supplies_tabs + * * @return string */ public function getRecipientSuppliesTabs() @@ -1809,7 +2190,9 @@ public function getRecipientSuppliesTabs() /** * Sets recipient_supplies_tabs + * * @param string $recipient_supplies_tabs + * * @return $this */ public function setRecipientSuppliesTabs($recipient_supplies_tabs) @@ -1821,6 +2204,7 @@ public function setRecipientSuppliesTabs($recipient_supplies_tabs) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1830,7 +2214,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1842,6 +2228,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1851,7 +2238,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1863,6 +2252,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1872,7 +2262,9 @@ public function getRequireIdLookup() /** * 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) @@ -1884,6 +2276,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1893,7 +2286,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1905,6 +2300,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets require_signer_certificate + * * @return string */ public function getRequireSignerCertificate() @@ -1914,7 +2310,9 @@ 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. + * * @return $this */ public function setRequireSignerCertificate($require_signer_certificate) @@ -1926,6 +2324,7 @@ public function setRequireSignerCertificate($require_signer_certificate) /** * Gets require_sign_on_paper + * * @return string */ public function getRequireSignOnPaper() @@ -1935,7 +2334,9 @@ public function getRequireSignOnPaper() /** * Sets require_sign_on_paper + * * @param string $require_sign_on_paper When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. + * * @return $this */ public function setRequireSignOnPaper($require_sign_on_paper) @@ -1947,6 +2348,7 @@ public function setRequireSignOnPaper($require_sign_on_paper) /** * Gets require_upload_signature + * * @return string */ public function getRequireUploadSignature() @@ -1956,7 +2358,9 @@ public function getRequireUploadSignature() /** * Sets require_upload_signature + * * @param string $require_upload_signature + * * @return $this */ public function setRequireUploadSignature($require_upload_signature) @@ -1968,6 +2372,7 @@ public function setRequireUploadSignature($require_upload_signature) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1977,7 +2382,9 @@ public function getRoleName() /** * 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) @@ -1989,6 +2396,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1998,7 +2406,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -2010,6 +2420,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -2019,7 +2430,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -2031,6 +2444,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -2040,7 +2454,9 @@ public function getSentDateTime() /** * 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) @@ -2052,6 +2468,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signature_info + * * @return \DocuSign\eSign\Model\RecipientSignatureInformation */ public function getSignatureInfo() @@ -2061,7 +2478,9 @@ public function getSignatureInfo() /** * Sets signature_info - * @param \DocuSign\eSign\Model\RecipientSignatureInformation $signature_info + * + * @param \DocuSign\eSign\Model\RecipientSignatureInformation $signature_info signature_info + * * @return $this */ public function setSignatureInfo($signature_info) @@ -2073,6 +2492,7 @@ public function setSignatureInfo($signature_info) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -2082,7 +2502,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -2094,6 +2516,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets sign_in_each_location + * * @return string */ public function getSignInEachLocation() @@ -2103,7 +2526,9 @@ public function getSignInEachLocation() /** * 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) @@ -2115,6 +2540,7 @@ public function setSignInEachLocation($sign_in_each_location) /** * Gets sign_in_each_location_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignInEachLocationMetadata() @@ -2124,7 +2550,9 @@ public function getSignInEachLocationMetadata() /** * Sets sign_in_each_location_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sign_in_each_location_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sign_in_each_location_metadata sign_in_each_location_metadata + * * @return $this */ public function setSignInEachLocationMetadata($sign_in_each_location_metadata) @@ -2136,6 +2564,7 @@ public function setSignInEachLocationMetadata($sign_in_each_location_metadata) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -2145,7 +2574,9 @@ public function getSigningGroupId() /** * 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) @@ -2157,6 +2588,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSigningGroupIdMetadata() @@ -2166,7 +2598,9 @@ public function getSigningGroupIdMetadata() /** * Sets signing_group_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata signing_group_id_metadata + * * @return $this */ public function setSigningGroupIdMetadata($signing_group_id_metadata) @@ -2178,6 +2612,7 @@ public function setSigningGroupIdMetadata($signing_group_id_metadata) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -2187,7 +2622,9 @@ public function getSigningGroupName() /** * 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) @@ -2199,6 +2636,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -2208,7 +2646,9 @@ public function getSigningGroupUsers() /** * 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) @@ -2220,6 +2660,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -2229,7 +2670,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -2241,6 +2684,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -2250,7 +2694,9 @@ public function getSocialAuthentications() /** * 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) @@ -2262,6 +2708,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -2271,7 +2718,9 @@ public function getStatus() /** * 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) @@ -2283,6 +2732,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -2292,7 +2742,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -2304,6 +2756,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -2313,7 +2766,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -2325,6 +2780,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -2334,7 +2790,9 @@ public function getTabs() /** * Sets tabs - * @param \DocuSign\eSign\Model\Tabs $tabs + * + * @param \DocuSign\eSign\Model\Tabs $tabs tabs + * * @return $this */ public function setTabs($tabs) @@ -2346,6 +2804,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2355,7 +2814,9 @@ public function getTemplateLocked() /** * 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) @@ -2367,6 +2828,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2376,7 +2838,9 @@ public function getTemplateRequired() /** * 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) @@ -2388,6 +2852,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -2397,7 +2862,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -2409,6 +2876,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -2418,7 +2886,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -2429,7 +2899,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2439,7 +2911,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2449,8 +2923,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2464,7 +2940,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2474,16 +2952,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SignerAttachment.php b/src/Model/SignerAttachment.php index 41d014dc..0216ae35 100644 --- a/src/Model/SignerAttachment.php +++ b/src/Model/SignerAttachment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SignerAttachment Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SignerAttachment implements ArrayAccess +class SignerAttachment implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signerAttachment'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -132,13 +135,114 @@ class SignerAttachment implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'optional' => null, + 'optional_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'scale_value' => null, + 'scale_value_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -220,9 +324,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -304,9 +408,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -388,34 +492,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -498,30 +631,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -531,7 +666,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -543,6 +680,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -552,7 +690,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -564,6 +704,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -573,7 +714,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -585,6 +728,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -594,7 +738,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -606,6 +752,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -615,7 +762,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -627,6 +776,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -636,7 +786,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -648,6 +800,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -657,7 +810,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -669,6 +824,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -678,7 +834,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -690,6 +848,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -699,7 +858,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -711,6 +872,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -720,7 +882,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -732,6 +896,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -741,7 +906,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -753,6 +920,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -762,7 +930,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -774,6 +944,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -783,7 +954,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -795,6 +968,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -804,7 +978,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -816,6 +992,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -825,7 +1002,9 @@ public function getAnchorUnits() /** * 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) @@ -837,6 +1016,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -846,7 +1026,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -858,6 +1040,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -867,7 +1050,9 @@ public function getAnchorXOffset() /** * 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) @@ -879,6 +1064,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -888,7 +1074,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -900,6 +1088,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -909,7 +1098,9 @@ public function getAnchorYOffset() /** * 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) @@ -921,6 +1112,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -930,7 +1122,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -942,6 +1136,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -951,7 +1146,9 @@ public function getConditionalParentLabel() /** * 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) @@ -963,6 +1160,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -972,7 +1170,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -984,6 +1184,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -993,7 +1194,9 @@ public function getConditionalParentValue() /** * 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) @@ -1005,6 +1208,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1014,7 +1218,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1026,6 +1232,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1035,7 +1242,9 @@ public function getCustomTabId() /** * 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) @@ -1047,6 +1256,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1056,7 +1266,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1068,6 +1280,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1077,7 +1290,9 @@ public function getDocumentId() /** * 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) @@ -1089,6 +1304,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1098,7 +1314,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1110,6 +1328,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1119,7 +1338,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1131,6 +1352,7 @@ public function setErrorDetails($error_details) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1140,7 +1362,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1152,6 +1376,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1161,7 +1386,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1173,6 +1400,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1182,7 +1410,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1194,6 +1424,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1203,7 +1434,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1215,6 +1448,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1224,7 +1458,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1236,6 +1472,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1245,7 +1482,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1257,6 +1496,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1266,7 +1506,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1278,6 +1520,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1287,7 +1530,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1299,6 +1544,7 @@ public function setHeightMetadata($height_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1308,7 +1554,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1320,6 +1568,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1329,7 +1578,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1341,6 +1592,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1350,7 +1602,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1362,6 +1616,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1371,7 +1626,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1383,6 +1640,7 @@ public function setNameMetadata($name_metadata) /** * Gets optional + * * @return string */ public function getOptional() @@ -1392,7 +1650,9 @@ public function getOptional() /** * Sets optional + * * @param string $optional + * * @return $this */ public function setOptional($optional) @@ -1404,6 +1664,7 @@ public function setOptional($optional) /** * Gets optional_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOptionalMetadata() @@ -1413,7 +1674,9 @@ public function getOptionalMetadata() /** * Sets optional_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $optional_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $optional_metadata optional_metadata + * * @return $this */ public function setOptionalMetadata($optional_metadata) @@ -1425,6 +1688,7 @@ public function setOptionalMetadata($optional_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1434,7 +1698,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1446,6 +1712,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1455,7 +1722,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1467,6 +1736,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1476,7 +1746,9 @@ public function getRecipientId() /** * 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) @@ -1488,6 +1760,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1497,7 +1770,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1509,6 +1784,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1518,7 +1794,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1530,6 +1808,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1539,7 +1818,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1551,6 +1832,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets scale_value + * * @return string */ public function getScaleValue() @@ -1560,7 +1842,9 @@ public function getScaleValue() /** * Sets scale_value + * * @param string $scale_value + * * @return $this */ public function setScaleValue($scale_value) @@ -1572,6 +1856,7 @@ public function setScaleValue($scale_value) /** * Gets scale_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getScaleValueMetadata() @@ -1581,7 +1866,9 @@ public function getScaleValueMetadata() /** * Sets scale_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $scale_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $scale_value_metadata scale_value_metadata + * * @return $this */ public function setScaleValueMetadata($scale_value_metadata) @@ -1593,6 +1880,7 @@ public function setScaleValueMetadata($scale_value_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1602,7 +1890,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1614,6 +1904,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1623,7 +1914,9 @@ public function getStatus() /** * 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) @@ -1635,6 +1928,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1644,7 +1938,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1656,6 +1952,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1665,7 +1962,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1677,6 +1976,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1686,7 +1986,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1698,6 +2000,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1707,7 +2010,9 @@ public function getTabId() /** * 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) @@ -1719,6 +2024,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1728,7 +2034,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1740,6 +2048,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1749,7 +2058,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1761,6 +2072,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -1770,7 +2082,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -1782,6 +2096,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1791,7 +2106,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1803,6 +2120,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1812,7 +2130,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -1824,6 +2144,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -1833,7 +2154,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -1845,6 +2168,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -1854,7 +2178,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -1866,6 +2192,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1875,7 +2202,9 @@ public function getTemplateLocked() /** * 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) @@ -1887,6 +2216,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -1896,7 +2226,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -1908,6 +2240,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1917,7 +2250,9 @@ public function getTemplateRequired() /** * 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) @@ -1929,6 +2264,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -1938,7 +2274,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -1950,6 +2288,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1959,7 +2298,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1971,6 +2312,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -1980,7 +2322,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -1992,6 +2336,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2001,7 +2346,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2013,6 +2360,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2022,7 +2370,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2034,6 +2384,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2043,7 +2394,9 @@ public function getXPosition() /** * 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) @@ -2055,6 +2408,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2064,7 +2418,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2076,6 +2432,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2085,7 +2442,9 @@ public function getYPosition() /** * 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) @@ -2097,6 +2456,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2106,7 +2466,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2117,7 +2479,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2127,7 +2491,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2137,8 +2503,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2152,7 +2520,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2162,16 +2532,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SignerEmailNotifications.php b/src/Model/SignerEmailNotifications.php index 1c37788b..7ba40836 100644 --- a/src/Model/SignerEmailNotifications.php +++ b/src/Model/SignerEmailNotifications.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SignerEmailNotifications Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SignerEmailNotifications implements ArrayAccess +class SignerEmailNotifications implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signerEmailNotifications'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -73,13 +76,54 @@ class SignerEmailNotifications implements ArrayAccess 'when_signing_group_member' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'agent_notification' => null, + 'carbon_copy_notification' => null, + 'certified_delivery_notification' => null, + 'comments_only_private_and_mention' => null, + 'comments_receive_all' => null, + 'document_markup_activation' => null, + 'envelope_activation' => null, + 'envelope_complete' => null, + 'envelope_corrected' => null, + 'envelope_declined' => null, + 'envelope_voided' => null, + 'fax_received' => null, + 'offline_signing_failed' => null, + 'purge_documents' => null, + 'reassigned_signer' => null, + 'when_signing_group_member' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -101,9 +145,9 @@ public static function swaggerTypes() 'when_signing_group_member' => 'whenSigningGroupMember' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -125,9 +169,9 @@ public static function swaggerTypes() 'when_signing_group_member' => 'setWhenSigningGroupMember' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -149,34 +193,63 @@ public static function swaggerTypes() 'when_signing_group_member' => 'getWhenSigningGroupMember' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -199,30 +272,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets agent_notification + * * @return string */ public function getAgentNotification() @@ -232,7 +307,9 @@ public function getAgentNotification() /** * Sets agent_notification + * * @param string $agent_notification When set to **true**, the user receives agent notification emails. + * * @return $this */ public function setAgentNotification($agent_notification) @@ -244,6 +321,7 @@ public function setAgentNotification($agent_notification) /** * Gets carbon_copy_notification + * * @return string */ public function getCarbonCopyNotification() @@ -253,7 +331,9 @@ public function getCarbonCopyNotification() /** * Sets carbon_copy_notification + * * @param string $carbon_copy_notification When set to **true**, the user receives notifications of carbon copy deliveries. + * * @return $this */ public function setCarbonCopyNotification($carbon_copy_notification) @@ -265,6 +345,7 @@ public function setCarbonCopyNotification($carbon_copy_notification) /** * Gets certified_delivery_notification + * * @return string */ public function getCertifiedDeliveryNotification() @@ -274,7 +355,9 @@ public function getCertifiedDeliveryNotification() /** * Sets certified_delivery_notification + * * @param string $certified_delivery_notification When set to **true**, the user receives notifications of certified deliveries. + * * @return $this */ public function setCertifiedDeliveryNotification($certified_delivery_notification) @@ -286,6 +369,7 @@ public function setCertifiedDeliveryNotification($certified_delivery_notificatio /** * Gets comments_only_private_and_mention + * * @return string */ public function getCommentsOnlyPrivateAndMention() @@ -295,7 +379,9 @@ public function getCommentsOnlyPrivateAndMention() /** * Sets comments_only_private_and_mention + * * @param string $comments_only_private_and_mention + * * @return $this */ public function setCommentsOnlyPrivateAndMention($comments_only_private_and_mention) @@ -307,6 +393,7 @@ public function setCommentsOnlyPrivateAndMention($comments_only_private_and_ment /** * Gets comments_receive_all + * * @return string */ public function getCommentsReceiveAll() @@ -316,7 +403,9 @@ public function getCommentsReceiveAll() /** * Sets comments_receive_all + * * @param string $comments_receive_all + * * @return $this */ public function setCommentsReceiveAll($comments_receive_all) @@ -328,6 +417,7 @@ public function setCommentsReceiveAll($comments_receive_all) /** * Gets document_markup_activation + * * @return string */ public function getDocumentMarkupActivation() @@ -337,7 +427,9 @@ public function getDocumentMarkupActivation() /** * Sets document_markup_activation + * * @param string $document_markup_activation When set to **true**, the user receives notification that document markup has been activated. + * * @return $this */ public function setDocumentMarkupActivation($document_markup_activation) @@ -349,6 +441,7 @@ public function setDocumentMarkupActivation($document_markup_activation) /** * Gets envelope_activation + * * @return string */ public function getEnvelopeActivation() @@ -358,7 +451,9 @@ public function getEnvelopeActivation() /** * Sets envelope_activation + * * @param string $envelope_activation When set to **true**, the user receives notification that the envelope has been activated. + * * @return $this */ public function setEnvelopeActivation($envelope_activation) @@ -370,6 +465,7 @@ public function setEnvelopeActivation($envelope_activation) /** * Gets envelope_complete + * * @return string */ public function getEnvelopeComplete() @@ -379,7 +475,9 @@ public function getEnvelopeComplete() /** * Sets envelope_complete + * * @param string $envelope_complete When set to **true**, the user receives notification that the envelope has been completed. + * * @return $this */ public function setEnvelopeComplete($envelope_complete) @@ -391,6 +489,7 @@ public function setEnvelopeComplete($envelope_complete) /** * Gets envelope_corrected + * * @return string */ public function getEnvelopeCorrected() @@ -400,7 +499,9 @@ public function getEnvelopeCorrected() /** * Sets envelope_corrected + * * @param string $envelope_corrected When set to **true**, the user receives notification that the envelope has been corrected. + * * @return $this */ public function setEnvelopeCorrected($envelope_corrected) @@ -412,6 +513,7 @@ public function setEnvelopeCorrected($envelope_corrected) /** * Gets envelope_declined + * * @return string */ public function getEnvelopeDeclined() @@ -421,7 +523,9 @@ public function getEnvelopeDeclined() /** * Sets envelope_declined + * * @param string $envelope_declined When set to **true**, the user receives notification that the envelope has been declined. + * * @return $this */ public function setEnvelopeDeclined($envelope_declined) @@ -433,6 +537,7 @@ public function setEnvelopeDeclined($envelope_declined) /** * Gets envelope_voided + * * @return string */ public function getEnvelopeVoided() @@ -442,7 +547,9 @@ public function getEnvelopeVoided() /** * Sets envelope_voided + * * @param string $envelope_voided When set to **true**, the user receives notification that the envelope has been voided. + * * @return $this */ public function setEnvelopeVoided($envelope_voided) @@ -454,6 +561,7 @@ public function setEnvelopeVoided($envelope_voided) /** * Gets fax_received + * * @return string */ public function getFaxReceived() @@ -463,7 +571,9 @@ public function getFaxReceived() /** * Sets fax_received + * * @param string $fax_received Reserved: + * * @return $this */ public function setFaxReceived($fax_received) @@ -475,6 +585,7 @@ public function setFaxReceived($fax_received) /** * Gets offline_signing_failed + * * @return string */ public function getOfflineSigningFailed() @@ -484,7 +595,9 @@ public function getOfflineSigningFailed() /** * Sets offline_signing_failed + * * @param string $offline_signing_failed When set to **true**, the user receives notification if the offline signing failed. + * * @return $this */ public function setOfflineSigningFailed($offline_signing_failed) @@ -496,6 +609,7 @@ public function setOfflineSigningFailed($offline_signing_failed) /** * Gets purge_documents + * * @return string */ public function getPurgeDocuments() @@ -505,7 +619,9 @@ public function getPurgeDocuments() /** * Sets purge_documents + * * @param string $purge_documents When set to **true**, the user receives notification of document purges. + * * @return $this */ public function setPurgeDocuments($purge_documents) @@ -517,6 +633,7 @@ public function setPurgeDocuments($purge_documents) /** * Gets reassigned_signer + * * @return string */ public function getReassignedSigner() @@ -526,7 +643,9 @@ public function getReassignedSigner() /** * Sets reassigned_signer + * * @param string $reassigned_signer When set to **true**, the user receives notification that the envelope has been reassigned. + * * @return $this */ public function setReassignedSigner($reassigned_signer) @@ -538,6 +657,7 @@ public function setReassignedSigner($reassigned_signer) /** * Gets when_signing_group_member + * * @return string */ public function getWhenSigningGroupMember() @@ -547,7 +667,9 @@ public function getWhenSigningGroupMember() /** * Sets when_signing_group_member + * * @param string $when_signing_group_member + * * @return $this */ public function setWhenSigningGroupMember($when_signing_group_member) @@ -558,7 +680,9 @@ public function setWhenSigningGroupMember($when_signing_group_member) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -568,7 +692,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -578,8 +704,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -593,7 +721,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -603,16 +733,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SigningGroup.php b/src/Model/SigningGroup.php index 9bebf22f..8055cefe 100644 --- a/src/Model/SigningGroup.php +++ b/src/Model/SigningGroup.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SigningGroup Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SigningGroup implements ArrayAccess +class SigningGroup implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signingGroup'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class SigningGroup implements ArrayAccess 'users' => '\DocuSign\eSign\Model\SigningGroupUser[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'created' => null, + 'created_by' => null, + 'error_details' => null, + 'group_email' => null, + 'group_name' => null, + 'group_type' => null, + 'modified' => null, + 'modified_by' => null, + 'signing_group_id' => null, + 'users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'users' => 'users' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'users' => 'setUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'users' => 'getUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets created + * * @return string */ public function getCreated() @@ -201,7 +270,9 @@ public function getCreated() /** * Sets created + * * @param string $created + * * @return $this */ public function setCreated($created) @@ -213,6 +284,7 @@ public function setCreated($created) /** * Gets created_by + * * @return string */ public function getCreatedBy() @@ -222,7 +294,9 @@ public function getCreatedBy() /** * Sets created_by + * * @param string $created_by + * * @return $this */ public function setCreatedBy($created_by) @@ -234,6 +308,7 @@ public function setCreatedBy($created_by) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -243,7 +318,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -255,6 +332,7 @@ public function setErrorDetails($error_details) /** * Gets group_email + * * @return string */ public function getGroupEmail() @@ -264,7 +342,9 @@ public function getGroupEmail() /** * Sets group_email + * * @param string $group_email + * * @return $this */ public function setGroupEmail($group_email) @@ -276,6 +356,7 @@ public function setGroupEmail($group_email) /** * Gets group_name + * * @return string */ public function getGroupName() @@ -285,7 +366,9 @@ public function getGroupName() /** * Sets group_name + * * @param string $group_name The name of the group. + * * @return $this */ public function setGroupName($group_name) @@ -297,6 +380,7 @@ public function setGroupName($group_name) /** * Gets group_type + * * @return string */ public function getGroupType() @@ -306,7 +390,9 @@ public function getGroupType() /** * Sets group_type + * * @param string $group_type + * * @return $this */ public function setGroupType($group_type) @@ -318,6 +404,7 @@ public function setGroupType($group_type) /** * Gets modified + * * @return string */ public function getModified() @@ -327,7 +414,9 @@ public function getModified() /** * Sets modified + * * @param string $modified + * * @return $this */ public function setModified($modified) @@ -339,6 +428,7 @@ public function setModified($modified) /** * Gets modified_by + * * @return string */ public function getModifiedBy() @@ -348,7 +438,9 @@ public function getModifiedBy() /** * Sets modified_by + * * @param string $modified_by + * * @return $this */ public function setModifiedBy($modified_by) @@ -360,6 +452,7 @@ public function setModifiedBy($modified_by) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -369,7 +462,9 @@ public function getSigningGroupId() /** * 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) @@ -381,6 +476,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets users + * * @return \DocuSign\eSign\Model\SigningGroupUser[] */ public function getUsers() @@ -390,7 +486,9 @@ public function getUsers() /** * Sets users + * * @param \DocuSign\eSign\Model\SigningGroupUser[] $users + * * @return $this */ public function setUsers($users) @@ -401,7 +499,9 @@ public function setUsers($users) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SigningGroupInformation.php b/src/Model/SigningGroupInformation.php index 5989843b..af89d40a 100644 --- a/src/Model/SigningGroupInformation.php +++ b/src/Model/SigningGroupInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SigningGroupInformation Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SigningGroupInformation implements ArrayAccess +class SigningGroupInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signingGroupInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'groups' => '\DocuSign\eSign\Model\SigningGroup[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'groups' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'groups' => 'groups' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'groups' => 'setGroups' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'groups' => 'getGroups' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets groups + * * @return \DocuSign\eSign\Model\SigningGroup[] */ public function getGroups() @@ -156,7 +216,9 @@ public function getGroups() /** * Sets groups + * * @param \DocuSign\eSign\Model\SigningGroup[] $groups A collection group objects containing information about the groups returned. + * * @return $this */ public function setGroups($groups) @@ -167,7 +229,9 @@ public function setGroups($groups) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SigningGroupUser.php b/src/Model/SigningGroupUser.php index a2f857a5..d0f747af 100644 --- a/src/Model/SigningGroupUser.php +++ b/src/Model/SigningGroupUser.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SigningGroupUser Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SigningGroupUser implements ArrayAccess +class SigningGroupUser implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signingGroupUser'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class SigningGroupUser implements ArrayAccess 'user_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'email' => null, + 'error_details' => null, + 'user_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'user_name' => 'userName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'user_name' => 'setUserName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'user_name' => 'getUserName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets email + * * @return string */ public function getEmail() @@ -166,7 +228,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -178,6 +242,7 @@ public function setEmail($email) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -187,7 +252,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -199,6 +266,7 @@ public function setErrorDetails($error_details) /** * Gets user_name + * * @return string */ public function getUserName() @@ -208,7 +276,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name The name of the group member. Maximum Length: 100 characters. + * * @return $this */ public function setUserName($user_name) @@ -219,7 +289,9 @@ public function setUserName($user_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SigningGroupUsers.php b/src/Model/SigningGroupUsers.php index 8036213e..ae437ea3 100644 --- a/src/Model/SigningGroupUsers.php +++ b/src/Model/SigningGroupUsers.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SigningGroupUsers Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SigningGroupUsers implements ArrayAccess +class SigningGroupUsers implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'signingGroupUsers'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'users' => '\DocuSign\eSign\Model\SigningGroupUser[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'users' => 'users' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'users' => 'setUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'users' => 'getUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets users + * * @return \DocuSign\eSign\Model\SigningGroupUser[] */ public function getUsers() @@ -156,7 +216,9 @@ public function getUsers() /** * Sets users + * * @param \DocuSign\eSign\Model\SigningGroupUser[] $users + * * @return $this */ public function setUsers($users) @@ -167,7 +229,9 @@ public function setUsers($users) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SmartContractInformation.php b/src/Model/SmartContractInformation.php index cc347784..4afe7dcb 100644 --- a/src/Model/SmartContractInformation.php +++ b/src/Model/SmartContractInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SmartContractInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SmartContractInformation implements ArrayAccess +class SmartContractInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'smartContractInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class SmartContractInformation implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'code' => null, + 'uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'uri' => 'getUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets code + * * @return string */ public function getCode() @@ -161,7 +222,9 @@ public function getCode() /** * Sets code + * * @param string $code + * * @return $this */ public function setCode($code) @@ -173,6 +236,7 @@ public function setCode($code) /** * Gets uri + * * @return string */ public function getUri() @@ -182,7 +246,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -193,7 +259,9 @@ public function setUri($uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SmartSection.php b/src/Model/SmartSection.php index 9c07e8c7..156827fe 100644 --- a/src/Model/SmartSection.php +++ b/src/Model/SmartSection.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SmartSection Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SmartSection implements ArrayAccess +class SmartSection implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'smartSection'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -139,13 +142,121 @@ class SmartSection implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'case_sensitive' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'display_settings' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'end_anchor' => null, + 'end_position' => null, + 'error_details' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'locked' => null, + 'locked_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'overlay_type' => null, + 'overlay_type_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'remove_end_anchor' => null, + 'remove_start_anchor' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'start_anchor' => null, + 'start_position' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -234,9 +345,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -325,9 +436,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -416,34 +527,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -533,30 +673,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -566,7 +708,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -578,6 +722,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -587,7 +732,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -599,6 +746,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -608,7 +756,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -620,6 +770,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -629,7 +780,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -641,6 +794,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -650,7 +804,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -662,6 +818,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -671,7 +828,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -683,6 +842,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -692,7 +852,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -704,6 +866,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -713,7 +876,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -725,6 +890,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -734,7 +900,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -746,6 +914,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -755,7 +924,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -767,6 +938,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -776,7 +948,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -788,6 +962,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -797,7 +972,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -809,6 +986,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -818,7 +996,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -830,6 +1010,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -839,7 +1020,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -851,6 +1034,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -860,7 +1044,9 @@ public function getAnchorUnits() /** * 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) @@ -872,6 +1058,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -881,7 +1068,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -893,6 +1082,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -902,7 +1092,9 @@ public function getAnchorXOffset() /** * 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) @@ -914,6 +1106,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -923,7 +1116,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -935,6 +1130,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -944,7 +1140,9 @@ public function getAnchorYOffset() /** * 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) @@ -956,6 +1154,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -965,7 +1164,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -977,6 +1178,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets case_sensitive + * * @return bool */ public function getCaseSensitive() @@ -986,7 +1188,9 @@ public function getCaseSensitive() /** * Sets case_sensitive + * * @param bool $case_sensitive + * * @return $this */ public function setCaseSensitive($case_sensitive) @@ -998,6 +1202,7 @@ public function setCaseSensitive($case_sensitive) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1007,7 +1212,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1019,6 +1226,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1028,7 +1236,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1040,6 +1250,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1049,7 +1260,9 @@ public function getConditionalParentValue() /** * 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) @@ -1061,6 +1274,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1070,7 +1284,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1082,6 +1298,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1091,7 +1308,9 @@ public function getCustomTabId() /** * 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) @@ -1103,6 +1322,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1112,7 +1332,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1124,6 +1346,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets display_settings + * * @return \DocuSign\eSign\Model\SmartSectionDisplaySettings */ public function getDisplaySettings() @@ -1133,7 +1356,9 @@ public function getDisplaySettings() /** * Sets display_settings - * @param \DocuSign\eSign\Model\SmartSectionDisplaySettings $display_settings + * + * @param \DocuSign\eSign\Model\SmartSectionDisplaySettings $display_settings display_settings + * * @return $this */ public function setDisplaySettings($display_settings) @@ -1145,6 +1370,7 @@ public function setDisplaySettings($display_settings) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1154,7 +1380,9 @@ public function getDocumentId() /** * 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) @@ -1166,6 +1394,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1175,7 +1404,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1187,6 +1418,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets end_anchor + * * @return string */ public function getEndAnchor() @@ -1196,7 +1428,9 @@ public function getEndAnchor() /** * Sets end_anchor + * * @param string $end_anchor + * * @return $this */ public function setEndAnchor($end_anchor) @@ -1208,6 +1442,7 @@ public function setEndAnchor($end_anchor) /** * Gets end_position + * * @return \DocuSign\eSign\Model\SmartSectionAnchorPosition */ public function getEndPosition() @@ -1217,7 +1452,9 @@ public function getEndPosition() /** * Sets end_position - * @param \DocuSign\eSign\Model\SmartSectionAnchorPosition $end_position + * + * @param \DocuSign\eSign\Model\SmartSectionAnchorPosition $end_position end_position + * * @return $this */ public function setEndPosition($end_position) @@ -1229,6 +1466,7 @@ public function setEndPosition($end_position) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1238,7 +1476,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1250,6 +1490,7 @@ public function setErrorDetails($error_details) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1259,7 +1500,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1271,6 +1514,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1280,7 +1524,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1292,6 +1538,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1301,7 +1548,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1313,6 +1562,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1322,7 +1572,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1334,6 +1586,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1343,7 +1596,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1355,6 +1610,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1364,7 +1620,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1376,6 +1634,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1385,7 +1644,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1397,6 +1658,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1406,7 +1668,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1418,6 +1682,7 @@ public function setHeightMetadata($height_metadata) /** * Gets locked + * * @return string */ public function getLocked() @@ -1427,7 +1692,9 @@ public function getLocked() /** * 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) @@ -1439,6 +1706,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1448,7 +1716,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1460,6 +1730,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1469,7 +1740,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1481,6 +1754,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1490,7 +1764,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1502,6 +1778,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets overlay_type + * * @return string */ public function getOverlayType() @@ -1511,7 +1788,9 @@ public function getOverlayType() /** * Sets overlay_type + * * @param string $overlay_type + * * @return $this */ public function setOverlayType($overlay_type) @@ -1523,6 +1802,7 @@ public function setOverlayType($overlay_type) /** * Gets overlay_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOverlayTypeMetadata() @@ -1532,7 +1812,9 @@ public function getOverlayTypeMetadata() /** * Sets overlay_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $overlay_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $overlay_type_metadata overlay_type_metadata + * * @return $this */ public function setOverlayTypeMetadata($overlay_type_metadata) @@ -1544,6 +1826,7 @@ public function setOverlayTypeMetadata($overlay_type_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1553,7 +1836,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1565,6 +1850,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1574,7 +1860,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1586,6 +1874,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1595,7 +1884,9 @@ public function getRecipientId() /** * 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) @@ -1607,6 +1898,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1616,7 +1908,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1628,6 +1922,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1637,7 +1932,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1649,6 +1946,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1658,7 +1956,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1670,6 +1970,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets remove_end_anchor + * * @return bool */ public function getRemoveEndAnchor() @@ -1679,7 +1980,9 @@ public function getRemoveEndAnchor() /** * Sets remove_end_anchor + * * @param bool $remove_end_anchor + * * @return $this */ public function setRemoveEndAnchor($remove_end_anchor) @@ -1691,6 +1994,7 @@ public function setRemoveEndAnchor($remove_end_anchor) /** * Gets remove_start_anchor + * * @return bool */ public function getRemoveStartAnchor() @@ -1700,7 +2004,9 @@ public function getRemoveStartAnchor() /** * Sets remove_start_anchor + * * @param bool $remove_start_anchor + * * @return $this */ public function setRemoveStartAnchor($remove_start_anchor) @@ -1712,6 +2018,7 @@ public function setRemoveStartAnchor($remove_start_anchor) /** * Gets shared + * * @return string */ public function getShared() @@ -1721,7 +2028,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1733,6 +2042,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -1742,7 +2052,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -1754,6 +2066,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1763,7 +2076,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1775,6 +2090,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets start_anchor + * * @return string */ public function getStartAnchor() @@ -1784,7 +2100,9 @@ public function getStartAnchor() /** * Sets start_anchor + * * @param string $start_anchor + * * @return $this */ public function setStartAnchor($start_anchor) @@ -1796,6 +2114,7 @@ public function setStartAnchor($start_anchor) /** * Gets start_position + * * @return \DocuSign\eSign\Model\SmartSectionAnchorPosition */ public function getStartPosition() @@ -1805,7 +2124,9 @@ public function getStartPosition() /** * Sets start_position - * @param \DocuSign\eSign\Model\SmartSectionAnchorPosition $start_position + * + * @param \DocuSign\eSign\Model\SmartSectionAnchorPosition $start_position start_position + * * @return $this */ public function setStartPosition($start_position) @@ -1817,6 +2138,7 @@ public function setStartPosition($start_position) /** * Gets status + * * @return string */ public function getStatus() @@ -1826,7 +2148,9 @@ public function getStatus() /** * 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) @@ -1838,6 +2162,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1847,7 +2172,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1859,6 +2186,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1868,7 +2196,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1880,6 +2210,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1889,7 +2220,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1901,6 +2234,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1910,7 +2244,9 @@ public function getTabId() /** * 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) @@ -1922,6 +2258,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1931,7 +2268,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1943,6 +2282,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1952,7 +2292,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1964,6 +2306,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1973,7 +2316,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1985,6 +2330,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1994,7 +2340,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2006,6 +2354,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2015,7 +2364,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2027,6 +2378,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2036,7 +2388,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2048,6 +2402,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2057,7 +2412,9 @@ public function getTemplateLocked() /** * 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) @@ -2069,6 +2426,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2078,7 +2436,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2090,6 +2450,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2099,7 +2460,9 @@ public function getTemplateRequired() /** * 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) @@ -2111,6 +2474,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2120,7 +2484,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2132,6 +2498,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2141,7 +2508,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2153,6 +2522,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2162,7 +2532,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2174,6 +2546,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2183,7 +2556,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2195,6 +2570,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2204,7 +2580,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2216,6 +2594,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2225,7 +2604,9 @@ public function getXPosition() /** * 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) @@ -2237,6 +2618,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2246,7 +2628,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2258,6 +2642,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2267,7 +2652,9 @@ public function getYPosition() /** * 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) @@ -2279,6 +2666,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2288,7 +2676,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2299,7 +2689,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2309,7 +2701,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2319,8 +2713,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2334,7 +2730,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2344,16 +2742,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SmartSectionAnchorPosition.php b/src/Model/SmartSectionAnchorPosition.php index eaed92fc..2b90862a 100644 --- a/src/Model/SmartSectionAnchorPosition.php +++ b/src/Model/SmartSectionAnchorPosition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SmartSectionAnchorPosition Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SmartSectionAnchorPosition implements ArrayAccess +class SmartSectionAnchorPosition implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'smartSectionAnchorPosition'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class SmartSectionAnchorPosition implements ArrayAccess 'y_position' => 'double' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'page_number' => 'int32', + 'x_position' => 'double', + 'y_position' => 'double' + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'y_position' => 'getYPosition' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets page_number + * * @return int */ public function getPageNumber() @@ -166,7 +228,9 @@ public function getPageNumber() /** * Sets page_number + * * @param int $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -178,6 +242,7 @@ public function setPageNumber($page_number) /** * Gets x_position + * * @return double */ public function getXPosition() @@ -187,7 +252,9 @@ public function getXPosition() /** * 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) @@ -199,6 +266,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return double */ public function getYPosition() @@ -208,7 +276,9 @@ public function getYPosition() /** * 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) @@ -219,7 +289,9 @@ public function setYPosition($y_position) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SmartSectionCollapsibleDisplaySettings.php b/src/Model/SmartSectionCollapsibleDisplaySettings.php index 0a16f109..625df443 100644 --- a/src/Model/SmartSectionCollapsibleDisplaySettings.php +++ b/src/Model/SmartSectionCollapsibleDisplaySettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SmartSectionCollapsibleDisplaySettings Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SmartSectionCollapsibleDisplaySettings implements ArrayAccess +class SmartSectionCollapsibleDisplaySettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'smartSectionCollapsibleDisplaySettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -66,13 +69,48 @@ class SmartSectionCollapsibleDisplaySettings implements ArrayAccess 'outer_label_and_arrow_style' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'arrow_closed' => null, + 'arrow_color' => null, + 'arrow_location' => null, + 'arrow_open' => null, + 'arrow_size' => null, + 'arrow_style' => null, + 'container_style' => null, + 'label_style' => null, + 'only_arrow_is_clickable' => null, + 'outer_label_and_arrow_style' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'outer_label_and_arrow_style' => 'outerLabelAndArrowStyle' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'outer_label_and_arrow_style' => 'setOuterLabelAndArrowStyle' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,63 @@ public static function swaggerTypes() 'outer_label_and_arrow_style' => 'getOuterLabelAndArrowStyle' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -168,30 +235,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets arrow_closed + * * @return string */ public function getArrowClosed() @@ -201,7 +270,9 @@ public function getArrowClosed() /** * Sets arrow_closed + * * @param string $arrow_closed + * * @return $this */ public function setArrowClosed($arrow_closed) @@ -213,6 +284,7 @@ public function setArrowClosed($arrow_closed) /** * Gets arrow_color + * * @return string */ public function getArrowColor() @@ -222,7 +294,9 @@ public function getArrowColor() /** * Sets arrow_color + * * @param string $arrow_color + * * @return $this */ public function setArrowColor($arrow_color) @@ -234,6 +308,7 @@ public function setArrowColor($arrow_color) /** * Gets arrow_location + * * @return string */ public function getArrowLocation() @@ -243,7 +318,9 @@ public function getArrowLocation() /** * Sets arrow_location + * * @param string $arrow_location + * * @return $this */ public function setArrowLocation($arrow_location) @@ -255,6 +332,7 @@ public function setArrowLocation($arrow_location) /** * Gets arrow_open + * * @return string */ public function getArrowOpen() @@ -264,7 +342,9 @@ public function getArrowOpen() /** * Sets arrow_open + * * @param string $arrow_open + * * @return $this */ public function setArrowOpen($arrow_open) @@ -276,6 +356,7 @@ public function setArrowOpen($arrow_open) /** * Gets arrow_size + * * @return string */ public function getArrowSize() @@ -285,7 +366,9 @@ public function getArrowSize() /** * Sets arrow_size + * * @param string $arrow_size + * * @return $this */ public function setArrowSize($arrow_size) @@ -297,6 +380,7 @@ public function setArrowSize($arrow_size) /** * Gets arrow_style + * * @return string */ public function getArrowStyle() @@ -306,7 +390,9 @@ public function getArrowStyle() /** * Sets arrow_style + * * @param string $arrow_style + * * @return $this */ public function setArrowStyle($arrow_style) @@ -318,6 +404,7 @@ public function setArrowStyle($arrow_style) /** * Gets container_style + * * @return string */ public function getContainerStyle() @@ -327,7 +414,9 @@ public function getContainerStyle() /** * Sets container_style + * * @param string $container_style + * * @return $this */ public function setContainerStyle($container_style) @@ -339,6 +428,7 @@ public function setContainerStyle($container_style) /** * Gets label_style + * * @return string */ public function getLabelStyle() @@ -348,7 +438,9 @@ public function getLabelStyle() /** * Sets label_style + * * @param string $label_style + * * @return $this */ public function setLabelStyle($label_style) @@ -360,6 +452,7 @@ public function setLabelStyle($label_style) /** * Gets only_arrow_is_clickable + * * @return bool */ public function getOnlyArrowIsClickable() @@ -369,7 +462,9 @@ public function getOnlyArrowIsClickable() /** * Sets only_arrow_is_clickable + * * @param bool $only_arrow_is_clickable + * * @return $this */ public function setOnlyArrowIsClickable($only_arrow_is_clickable) @@ -381,6 +476,7 @@ public function setOnlyArrowIsClickable($only_arrow_is_clickable) /** * Gets outer_label_and_arrow_style + * * @return string */ public function getOuterLabelAndArrowStyle() @@ -390,7 +486,9 @@ public function getOuterLabelAndArrowStyle() /** * Sets outer_label_and_arrow_style + * * @param string $outer_label_and_arrow_style + * * @return $this */ public function setOuterLabelAndArrowStyle($outer_label_and_arrow_style) @@ -401,7 +499,9 @@ public function setOuterLabelAndArrowStyle($outer_label_and_arrow_style) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -411,7 +511,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -421,8 +523,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -436,7 +540,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -446,16 +552,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SmartSectionDisplaySettings.php b/src/Model/SmartSectionDisplaySettings.php index 4dd4cc5b..3f70598c 100644 --- a/src/Model/SmartSectionDisplaySettings.php +++ b/src/Model/SmartSectionDisplaySettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SmartSectionDisplaySettings Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SmartSectionDisplaySettings implements ArrayAccess +class SmartSectionDisplaySettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'smartSectionDisplaySettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -68,13 +71,50 @@ class SmartSectionDisplaySettings implements ArrayAccess 'table_style' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'cell_style' => null, + 'collapsible_settings' => null, + 'display' => null, + 'display_label' => null, + 'display_order' => 'int32', + 'display_page_number' => 'int32', + 'hide_label_when_opened' => null, + 'inline_outer_style' => null, + 'label_when_opened' => null, + 'pre_label' => null, + 'scroll_to_top_when_opened' => null, + 'table_style' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -92,9 +132,9 @@ public static function swaggerTypes() 'table_style' => 'tableStyle' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,9 +152,9 @@ public static function swaggerTypes() 'table_style' => 'setTableStyle' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -132,34 +172,63 @@ public static function swaggerTypes() 'table_style' => 'getTableStyle' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -178,30 +247,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets cell_style + * * @return string */ public function getCellStyle() @@ -211,7 +282,9 @@ public function getCellStyle() /** * Sets cell_style + * * @param string $cell_style + * * @return $this */ public function setCellStyle($cell_style) @@ -223,6 +296,7 @@ public function setCellStyle($cell_style) /** * Gets collapsible_settings + * * @return \DocuSign\eSign\Model\SmartSectionCollapsibleDisplaySettings */ public function getCollapsibleSettings() @@ -232,7 +306,9 @@ public function getCollapsibleSettings() /** * Sets collapsible_settings - * @param \DocuSign\eSign\Model\SmartSectionCollapsibleDisplaySettings $collapsible_settings + * + * @param \DocuSign\eSign\Model\SmartSectionCollapsibleDisplaySettings $collapsible_settings collapsible_settings + * * @return $this */ public function setCollapsibleSettings($collapsible_settings) @@ -244,6 +320,7 @@ public function setCollapsibleSettings($collapsible_settings) /** * Gets display + * * @return string */ public function getDisplay() @@ -253,7 +330,9 @@ public function getDisplay() /** * Sets display + * * @param string $display + * * @return $this */ public function setDisplay($display) @@ -265,6 +344,7 @@ public function setDisplay($display) /** * Gets display_label + * * @return string */ public function getDisplayLabel() @@ -274,7 +354,9 @@ public function getDisplayLabel() /** * Sets display_label + * * @param string $display_label + * * @return $this */ public function setDisplayLabel($display_label) @@ -286,6 +368,7 @@ public function setDisplayLabel($display_label) /** * Gets display_order + * * @return int */ public function getDisplayOrder() @@ -295,7 +378,9 @@ public function getDisplayOrder() /** * Sets display_order + * * @param int $display_order + * * @return $this */ public function setDisplayOrder($display_order) @@ -307,6 +392,7 @@ public function setDisplayOrder($display_order) /** * Gets display_page_number + * * @return int */ public function getDisplayPageNumber() @@ -316,7 +402,9 @@ public function getDisplayPageNumber() /** * Sets display_page_number + * * @param int $display_page_number + * * @return $this */ public function setDisplayPageNumber($display_page_number) @@ -328,6 +416,7 @@ public function setDisplayPageNumber($display_page_number) /** * Gets hide_label_when_opened + * * @return bool */ public function getHideLabelWhenOpened() @@ -337,7 +426,9 @@ public function getHideLabelWhenOpened() /** * Sets hide_label_when_opened + * * @param bool $hide_label_when_opened + * * @return $this */ public function setHideLabelWhenOpened($hide_label_when_opened) @@ -349,6 +440,7 @@ public function setHideLabelWhenOpened($hide_label_when_opened) /** * Gets inline_outer_style + * * @return string */ public function getInlineOuterStyle() @@ -358,7 +450,9 @@ public function getInlineOuterStyle() /** * Sets inline_outer_style + * * @param string $inline_outer_style + * * @return $this */ public function setInlineOuterStyle($inline_outer_style) @@ -370,6 +464,7 @@ public function setInlineOuterStyle($inline_outer_style) /** * Gets label_when_opened + * * @return string */ public function getLabelWhenOpened() @@ -379,7 +474,9 @@ public function getLabelWhenOpened() /** * Sets label_when_opened + * * @param string $label_when_opened + * * @return $this */ public function setLabelWhenOpened($label_when_opened) @@ -391,6 +488,7 @@ public function setLabelWhenOpened($label_when_opened) /** * Gets pre_label + * * @return string */ public function getPreLabel() @@ -400,7 +498,9 @@ public function getPreLabel() /** * Sets pre_label + * * @param string $pre_label + * * @return $this */ public function setPreLabel($pre_label) @@ -412,6 +512,7 @@ public function setPreLabel($pre_label) /** * Gets scroll_to_top_when_opened + * * @return bool */ public function getScrollToTopWhenOpened() @@ -421,7 +522,9 @@ public function getScrollToTopWhenOpened() /** * Sets scroll_to_top_when_opened + * * @param bool $scroll_to_top_when_opened + * * @return $this */ public function setScrollToTopWhenOpened($scroll_to_top_when_opened) @@ -433,6 +536,7 @@ public function setScrollToTopWhenOpened($scroll_to_top_when_opened) /** * Gets table_style + * * @return string */ public function getTableStyle() @@ -442,7 +546,9 @@ public function getTableStyle() /** * Sets table_style + * * @param string $table_style + * * @return $this */ public function setTableStyle($table_style) @@ -453,7 +559,9 @@ public function setTableStyle($table_style) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -463,7 +571,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -473,8 +583,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -488,7 +600,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -498,16 +612,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SocialAccountInformation.php b/src/Model/SocialAccountInformation.php index b2421835..c322cdc6 100644 --- a/src/Model/SocialAccountInformation.php +++ b/src/Model/SocialAccountInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SocialAccountInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SocialAccountInformation implements ArrayAccess +class SocialAccountInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'socialAccountInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,43 @@ class SocialAccountInformation implements ArrayAccess 'user_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'email' => null, + 'error_details' => null, + 'provider' => null, + 'social_id' => null, + 'user_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -78,9 +111,9 @@ public static function swaggerTypes() 'user_name' => 'userName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -91,9 +124,9 @@ public static function swaggerTypes() 'user_name' => 'setUserName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -104,34 +137,63 @@ public static function swaggerTypes() 'user_name' => 'getUserName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -143,30 +205,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets email + * * @return string */ public function getEmail() @@ -176,7 +240,9 @@ public function getEmail() /** * Sets email + * * @param string $email The users email address. + * * @return $this */ public function setEmail($email) @@ -188,6 +254,7 @@ public function setEmail($email) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -197,7 +264,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -209,6 +278,7 @@ public function setErrorDetails($error_details) /** * Gets provider + * * @return string */ public function getProvider() @@ -218,7 +288,9 @@ public function getProvider() /** * Sets provider + * * @param string $provider The social account provider (Facebook, Yahoo, etc.) + * * @return $this */ public function setProvider($provider) @@ -230,6 +302,7 @@ public function setProvider($provider) /** * Gets social_id + * * @return string */ public function getSocialId() @@ -239,7 +312,9 @@ public function getSocialId() /** * Sets social_id + * * @param string $social_id The ID provided by the Socal Account. + * * @return $this */ public function setSocialId($social_id) @@ -251,6 +326,7 @@ public function setSocialId($social_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -260,7 +336,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name The full user name for the account. + * * @return $this */ public function setUserName($user_name) @@ -271,7 +349,9 @@ public function setUserName($user_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -281,7 +361,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -291,8 +373,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -306,7 +390,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -316,16 +402,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SocialAuthentication.php b/src/Model/SocialAuthentication.php index d3fb14ba..8eadba8a 100644 --- a/src/Model/SocialAuthentication.php +++ b/src/Model/SocialAuthentication.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SocialAuthentication Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SocialAuthentication implements ArrayAccess +class SocialAuthentication implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'socialAuthentication'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'authentication' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'authentication' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'authentication' => 'authentication' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'authentication' => 'setAuthentication' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'authentication' => 'getAuthentication' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets authentication + * * @return string */ public function getAuthentication() @@ -156,7 +216,9 @@ public function getAuthentication() /** * Sets authentication + * * @param string $authentication Reserved: TBD + * * @return $this */ public function setAuthentication($authentication) @@ -167,7 +229,9 @@ public function setAuthentication($authentication) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Ssn.php b/src/Model/Ssn.php index 8854bc98..c5212486 100644 --- a/src/Model/Ssn.php +++ b/src/Model/Ssn.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Ssn Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Ssn implements ArrayAccess +class Ssn implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'ssn'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -167,13 +170,149 @@ class Ssn implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conceal_value_on_document' => null, + 'conceal_value_on_document_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'disable_auto_size' => null, + 'disable_auto_size_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'max_length' => null, + 'max_length_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'original_value' => null, + 'original_value_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'require_all' => null, + 'require_all_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'sender_required' => null, + 'sender_required_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'validation_message' => null, + 'validation_message_metadata' => null, + 'validation_pattern' => null, + 'validation_pattern_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -290,9 +429,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -409,9 +548,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -528,34 +667,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -673,30 +841,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -706,7 +876,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -718,6 +890,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -727,7 +900,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -739,6 +914,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -748,7 +924,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -760,6 +938,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -769,7 +948,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -781,6 +962,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -790,7 +972,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -802,6 +986,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -811,7 +996,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -823,6 +1010,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -832,7 +1020,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -844,6 +1034,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -853,7 +1044,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -865,6 +1058,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -874,7 +1068,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -886,6 +1082,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -895,7 +1092,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -907,6 +1106,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -916,7 +1116,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -928,6 +1130,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -937,7 +1140,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -949,6 +1154,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -958,7 +1164,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -970,6 +1178,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -979,7 +1188,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -991,6 +1202,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -1000,7 +1212,9 @@ public function getAnchorUnits() /** * 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) @@ -1012,6 +1226,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -1021,7 +1236,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -1033,6 +1250,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -1042,7 +1260,9 @@ public function getAnchorXOffset() /** * 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) @@ -1054,6 +1274,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1063,7 +1284,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1075,6 +1298,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1084,7 +1308,9 @@ public function getAnchorYOffset() /** * 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) @@ -1096,6 +1322,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1105,7 +1332,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1117,6 +1346,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1126,7 +1356,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1138,6 +1370,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1147,7 +1380,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1159,6 +1394,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -1168,7 +1404,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -1180,6 +1418,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conceal_value_on_document_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConcealValueOnDocumentMetadata() @@ -1189,7 +1428,9 @@ public function getConcealValueOnDocumentMetadata() /** * Sets conceal_value_on_document_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata conceal_value_on_document_metadata + * * @return $this */ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_metadata) @@ -1201,6 +1442,7 @@ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_met /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1210,7 +1452,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1222,6 +1466,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1231,7 +1476,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1243,6 +1490,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1252,7 +1500,9 @@ public function getConditionalParentValue() /** * 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) @@ -1264,6 +1514,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1273,7 +1524,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1285,6 +1538,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1294,7 +1548,9 @@ public function getCustomTabId() /** * 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) @@ -1306,6 +1562,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1315,7 +1572,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1327,6 +1586,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -1336,7 +1596,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -1348,6 +1610,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets disable_auto_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisableAutoSizeMetadata() @@ -1357,7 +1620,9 @@ public function getDisableAutoSizeMetadata() /** * Sets disable_auto_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata disable_auto_size_metadata + * * @return $this */ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) @@ -1369,6 +1634,7 @@ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1378,7 +1644,9 @@ public function getDocumentId() /** * 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) @@ -1390,6 +1658,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1399,7 +1668,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1411,6 +1682,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1420,7 +1692,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1432,6 +1706,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1441,7 +1716,9 @@ public function getFont() /** * 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) @@ -1453,6 +1730,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1462,7 +1740,9 @@ public function getFontColor() /** * 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) @@ -1474,6 +1754,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1483,7 +1764,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1495,6 +1778,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1504,7 +1788,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1516,6 +1802,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1525,7 +1812,9 @@ public function getFontSize() /** * 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) @@ -1537,6 +1826,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1546,7 +1836,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1558,6 +1850,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1567,7 +1860,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1579,6 +1874,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1588,7 +1884,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1600,6 +1898,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1609,7 +1908,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1621,6 +1922,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1630,7 +1932,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1642,6 +1946,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1651,7 +1956,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1663,6 +1970,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1672,7 +1980,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1684,6 +1994,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1693,7 +2004,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1705,6 +2018,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1714,7 +2028,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1726,6 +2042,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1735,7 +2052,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1747,6 +2066,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1756,7 +2076,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1768,6 +2090,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1777,7 +2100,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1789,6 +2114,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1798,7 +2124,9 @@ public function getLocked() /** * 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) @@ -1810,6 +2138,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1819,7 +2148,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1831,6 +2162,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets max_length + * * @return string */ public function getMaxLength() @@ -1840,7 +2172,9 @@ public function getMaxLength() /** * Sets max_length + * * @param string $max_length An optional value that describes the maximum length of the property when the property is a string. + * * @return $this */ public function setMaxLength($max_length) @@ -1852,6 +2186,7 @@ public function setMaxLength($max_length) /** * Gets max_length_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaxLengthMetadata() @@ -1861,7 +2196,9 @@ public function getMaxLengthMetadata() /** * Sets max_length_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata max_length_metadata + * * @return $this */ public function setMaxLengthMetadata($max_length_metadata) @@ -1873,6 +2210,7 @@ public function setMaxLengthMetadata($max_length_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1882,7 +2220,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1894,6 +2234,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1903,7 +2244,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1915,6 +2258,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1924,7 +2268,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -1936,6 +2282,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1945,7 +2292,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1957,6 +2306,7 @@ public function setNameMetadata($name_metadata) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -1966,7 +2316,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -1978,6 +2330,7 @@ public function setOriginalValue($original_value) /** * Gets original_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOriginalValueMetadata() @@ -1987,7 +2340,9 @@ public function getOriginalValueMetadata() /** * Sets original_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata original_value_metadata + * * @return $this */ public function setOriginalValueMetadata($original_value_metadata) @@ -1999,6 +2354,7 @@ public function setOriginalValueMetadata($original_value_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -2008,7 +2364,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -2020,6 +2378,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -2029,7 +2388,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -2041,6 +2402,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -2050,7 +2412,9 @@ public function getRecipientId() /** * 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) @@ -2062,6 +2426,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -2071,7 +2436,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -2083,6 +2450,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -2092,7 +2460,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -2104,6 +2474,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -2113,7 +2484,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -2125,6 +2498,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -2134,7 +2508,9 @@ public function getRequireAll() /** * 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) @@ -2146,6 +2522,7 @@ public function setRequireAll($require_all) /** * Gets require_all_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireAllMetadata() @@ -2155,7 +2532,9 @@ public function getRequireAllMetadata() /** * Sets require_all_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata require_all_metadata + * * @return $this */ public function setRequireAllMetadata($require_all_metadata) @@ -2167,6 +2546,7 @@ public function setRequireAllMetadata($require_all_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -2176,7 +2556,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -2188,6 +2570,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -2197,7 +2580,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2209,6 +2594,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -2218,7 +2604,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -2230,6 +2618,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -2239,7 +2628,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -2251,6 +2642,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -2260,7 +2652,9 @@ public function getSenderRequired() /** * 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. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + * * @return $this */ public function setSenderRequired($sender_required) @@ -2272,6 +2666,7 @@ public function setSenderRequired($sender_required) /** * Gets sender_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderRequiredMetadata() @@ -2281,7 +2676,9 @@ public function getSenderRequiredMetadata() /** * Sets sender_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata sender_required_metadata + * * @return $this */ public function setSenderRequiredMetadata($sender_required_metadata) @@ -2293,6 +2690,7 @@ public function setSenderRequiredMetadata($sender_required_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -2302,7 +2700,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -2314,6 +2714,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -2323,7 +2724,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -2335,6 +2738,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2344,7 +2748,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2356,6 +2762,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2365,7 +2772,9 @@ public function getStatus() /** * 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) @@ -2377,6 +2786,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2386,7 +2796,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2398,6 +2810,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2407,7 +2820,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2419,6 +2834,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2428,7 +2844,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2440,6 +2858,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2449,7 +2868,9 @@ public function getTabId() /** * 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) @@ -2461,6 +2882,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2470,7 +2892,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2482,6 +2906,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2491,7 +2916,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2503,6 +2930,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2512,7 +2940,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2524,6 +2954,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2533,7 +2964,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2545,6 +2978,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2554,7 +2988,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2566,6 +3002,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2575,7 +3012,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2587,6 +3026,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2596,7 +3036,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2608,6 +3050,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2617,7 +3060,9 @@ public function getTemplateLocked() /** * 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) @@ -2629,6 +3074,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2638,7 +3084,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2650,6 +3098,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2659,7 +3108,9 @@ public function getTemplateRequired() /** * 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) @@ -2671,6 +3122,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2680,7 +3132,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2692,6 +3146,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2701,7 +3156,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2713,6 +3170,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2722,7 +3180,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2734,6 +3194,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2743,7 +3204,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2755,6 +3218,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2764,7 +3228,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2776,6 +3242,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -2785,7 +3252,9 @@ public function getValidationMessage() /** * Sets validation_message + * * @param string $validation_message The message displayed if the custom tab fails input validation (either custom of embedded). + * * @return $this */ public function setValidationMessage($validation_message) @@ -2797,6 +3266,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_message_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationMessageMetadata() @@ -2806,7 +3276,9 @@ public function getValidationMessageMetadata() /** * Sets validation_message_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata validation_message_metadata + * * @return $this */ public function setValidationMessageMetadata($validation_message_metadata) @@ -2818,6 +3290,7 @@ public function setValidationMessageMetadata($validation_message_metadata) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -2827,7 +3300,9 @@ public function getValidationPattern() /** * Sets validation_pattern + * * @param string $validation_pattern A regular expression used to validate input for the tab. + * * @return $this */ public function setValidationPattern($validation_pattern) @@ -2839,6 +3314,7 @@ public function setValidationPattern($validation_pattern) /** * Gets validation_pattern_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationPatternMetadata() @@ -2848,7 +3324,9 @@ public function getValidationPatternMetadata() /** * Sets validation_pattern_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata validation_pattern_metadata + * * @return $this */ public function setValidationPatternMetadata($validation_pattern_metadata) @@ -2860,6 +3338,7 @@ public function setValidationPatternMetadata($validation_pattern_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2869,7 +3348,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2881,6 +3362,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2890,7 +3372,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2902,6 +3386,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2911,7 +3396,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2923,6 +3410,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2932,7 +3420,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2944,6 +3434,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2953,7 +3444,9 @@ public function getXPosition() /** * 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) @@ -2965,6 +3458,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2974,7 +3468,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2986,6 +3482,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2995,7 +3492,9 @@ public function getYPosition() /** * 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) @@ -3007,6 +3506,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -3016,7 +3516,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -3027,7 +3529,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -3037,7 +3541,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -3047,8 +3553,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -3062,7 +3570,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -3072,16 +3582,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Ssn4InformationInput.php b/src/Model/Ssn4InformationInput.php index 1b771318..4778da3a 100644 --- a/src/Model/Ssn4InformationInput.php +++ b/src/Model/Ssn4InformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Ssn4InformationInput Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Ssn4InformationInput implements ArrayAccess +class Ssn4InformationInput implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'ssn4InformationInput'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class Ssn4InformationInput implements ArrayAccess 'ssn4' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'display_level_code' => null, + 'receive_in_response' => null, + 'ssn4' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'ssn4' => 'ssn4' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'ssn4' => 'setSsn4' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'ssn4' => 'getSsn4' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets display_level_code + * * @return string */ public function getDisplayLevelCode() @@ -166,7 +228,9 @@ public function getDisplayLevelCode() /** * Sets display_level_code + * * @param string $display_level_code Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay + * * @return $this */ public function setDisplayLevelCode($display_level_code) @@ -178,6 +242,7 @@ public function setDisplayLevelCode($display_level_code) /** * Gets receive_in_response + * * @return string */ public function getReceiveInResponse() @@ -187,7 +252,9 @@ public function getReceiveInResponse() /** * Sets receive_in_response + * * @param string $receive_in_response When set to **true**, the information needs to be returned in the response. + * * @return $this */ public function setReceiveInResponse($receive_in_response) @@ -199,6 +266,7 @@ public function setReceiveInResponse($receive_in_response) /** * Gets ssn4 + * * @return string */ public function getSsn4() @@ -208,7 +276,9 @@ public function getSsn4() /** * Sets ssn4 + * * @param string $ssn4 The last four digits of the recipient's Social Security Number (SSN). + * * @return $this */ public function setSsn4($ssn4) @@ -219,7 +289,9 @@ public function setSsn4($ssn4) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Ssn9InformationInput.php b/src/Model/Ssn9InformationInput.php index 9957b390..d6e5d5cc 100644 --- a/src/Model/Ssn9InformationInput.php +++ b/src/Model/Ssn9InformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Ssn9InformationInput Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Ssn9InformationInput implements ArrayAccess +class Ssn9InformationInput implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'ssn9InformationInput'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class Ssn9InformationInput implements ArrayAccess 'ssn9' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'display_level_code' => null, + 'ssn9' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'ssn9' => 'ssn9' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'ssn9' => 'setSsn9' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'ssn9' => 'getSsn9' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets display_level_code + * * @return string */ public function getDisplayLevelCode() @@ -161,7 +222,9 @@ public function getDisplayLevelCode() /** * Sets display_level_code + * * @param string $display_level_code Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay + * * @return $this */ public function setDisplayLevelCode($display_level_code) @@ -173,6 +236,7 @@ public function setDisplayLevelCode($display_level_code) /** * Gets ssn9 + * * @return string */ public function getSsn9() @@ -182,7 +246,9 @@ public function getSsn9() /** * Sets ssn9 + * * @param string $ssn9 The recipient's Social Security Number(SSN). + * * @return $this */ public function setSsn9($ssn9) @@ -193,7 +259,9 @@ public function setSsn9($ssn9) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Stamp.php b/src/Model/Stamp.php index ed525d12..bd9d61ed 100644 --- a/src/Model/Stamp.php +++ b/src/Model/Stamp.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Stamp Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Stamp implements ArrayAccess +class Stamp implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'stamp'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -72,13 +75,54 @@ class Stamp implements ArrayAccess 'status' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'adopted_date_time' => null, + 'created_date_time' => null, + 'custom_field' => null, + 'date_stamp_properties' => null, + 'disallow_user_resize_stamp' => null, + 'error_details' => null, + 'external_id' => null, + 'image_base64' => null, + 'image_type' => null, + 'last_modified_date_time' => null, + 'phonetic_name' => null, + 'signature_name' => null, + 'stamp_format' => null, + 'stamp_image_uri' => null, + 'stamp_size_mm' => null, + 'status' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -100,9 +144,9 @@ public static function swaggerTypes() 'status' => 'status' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -124,9 +168,9 @@ public static function swaggerTypes() 'status' => 'setStatus' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -148,34 +192,63 @@ public static function swaggerTypes() 'status' => 'getStatus' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -198,30 +271,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets adopted_date_time + * * @return string */ public function getAdoptedDateTime() @@ -231,7 +306,9 @@ public function getAdoptedDateTime() /** * Sets adopted_date_time + * * @param string $adopted_date_time + * * @return $this */ public function setAdoptedDateTime($adopted_date_time) @@ -243,6 +320,7 @@ public function setAdoptedDateTime($adopted_date_time) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -252,7 +330,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -264,6 +344,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_field + * * @return string */ public function getCustomField() @@ -273,7 +354,9 @@ public function getCustomField() /** * Sets custom_field + * * @param string $custom_field + * * @return $this */ public function setCustomField($custom_field) @@ -285,6 +368,7 @@ public function setCustomField($custom_field) /** * Gets date_stamp_properties + * * @return \DocuSign\eSign\Model\DateStampProperties */ public function getDateStampProperties() @@ -294,7 +378,9 @@ public function getDateStampProperties() /** * Sets date_stamp_properties - * @param \DocuSign\eSign\Model\DateStampProperties $date_stamp_properties + * + * @param \DocuSign\eSign\Model\DateStampProperties $date_stamp_properties date_stamp_properties + * * @return $this */ public function setDateStampProperties($date_stamp_properties) @@ -306,6 +392,7 @@ public function setDateStampProperties($date_stamp_properties) /** * Gets disallow_user_resize_stamp + * * @return string */ public function getDisallowUserResizeStamp() @@ -315,7 +402,9 @@ public function getDisallowUserResizeStamp() /** * Sets disallow_user_resize_stamp + * * @param string $disallow_user_resize_stamp + * * @return $this */ public function setDisallowUserResizeStamp($disallow_user_resize_stamp) @@ -327,6 +416,7 @@ public function setDisallowUserResizeStamp($disallow_user_resize_stamp) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -336,7 +426,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -348,6 +440,7 @@ public function setErrorDetails($error_details) /** * Gets external_id + * * @return string */ public function getExternalId() @@ -357,7 +450,9 @@ public function getExternalId() /** * Sets external_id + * * @param string $external_id + * * @return $this */ public function setExternalId($external_id) @@ -369,6 +464,7 @@ public function setExternalId($external_id) /** * Gets image_base64 + * * @return string */ public function getImageBase64() @@ -378,7 +474,9 @@ public function getImageBase64() /** * Sets image_base64 + * * @param string $image_base64 + * * @return $this */ public function setImageBase64($image_base64) @@ -390,6 +488,7 @@ public function setImageBase64($image_base64) /** * Gets image_type + * * @return string */ public function getImageType() @@ -399,7 +498,9 @@ public function getImageType() /** * Sets image_type + * * @param string $image_type + * * @return $this */ public function setImageType($image_type) @@ -411,6 +512,7 @@ public function setImageType($image_type) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -420,7 +522,9 @@ public function getLastModifiedDateTime() /** * Sets last_modified_date_time + * * @param string $last_modified_date_time The date and time the item was last modified. + * * @return $this */ public function setLastModifiedDateTime($last_modified_date_time) @@ -432,6 +536,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets phonetic_name + * * @return string */ public function getPhoneticName() @@ -441,7 +546,9 @@ public function getPhoneticName() /** * Sets phonetic_name + * * @param string $phonetic_name + * * @return $this */ public function setPhoneticName($phonetic_name) @@ -453,6 +560,7 @@ public function setPhoneticName($phonetic_name) /** * Gets signature_name + * * @return string */ public function getSignatureName() @@ -462,7 +570,9 @@ public function getSignatureName() /** * Sets signature_name + * * @param string $signature_name Specifies the user signature name. + * * @return $this */ public function setSignatureName($signature_name) @@ -474,6 +584,7 @@ public function setSignatureName($signature_name) /** * Gets stamp_format + * * @return string */ public function getStampFormat() @@ -483,7 +594,9 @@ public function getStampFormat() /** * Sets stamp_format + * * @param string $stamp_format + * * @return $this */ public function setStampFormat($stamp_format) @@ -495,6 +608,7 @@ public function setStampFormat($stamp_format) /** * Gets stamp_image_uri + * * @return string */ public function getStampImageUri() @@ -504,7 +618,9 @@ public function getStampImageUri() /** * Sets stamp_image_uri + * * @param string $stamp_image_uri + * * @return $this */ public function setStampImageUri($stamp_image_uri) @@ -516,6 +632,7 @@ public function setStampImageUri($stamp_image_uri) /** * Gets stamp_size_mm + * * @return string */ public function getStampSizeMm() @@ -525,7 +642,9 @@ public function getStampSizeMm() /** * Sets stamp_size_mm + * * @param string $stamp_size_mm + * * @return $this */ public function setStampSizeMm($stamp_size_mm) @@ -537,6 +656,7 @@ public function setStampSizeMm($stamp_size_mm) /** * Gets status + * * @return string */ public function getStatus() @@ -546,7 +666,9 @@ public function getStatus() /** * 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) @@ -557,7 +679,9 @@ public function setStatus($status) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -567,7 +691,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -577,8 +703,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -592,7 +720,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -602,16 +732,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/SupportedLanguages.php b/src/Model/SupportedLanguages.php index 174d1196..ebb0752f 100644 --- a/src/Model/SupportedLanguages.php +++ b/src/Model/SupportedLanguages.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SupportedLanguages Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SupportedLanguages implements ArrayAccess +class SupportedLanguages implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'supportedLanguages'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'languages' => '\DocuSign\eSign\Model\NameValue[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'languages' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ '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' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets languages + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getLanguages() @@ -156,7 +216,9 @@ public function getLanguages() /** * Sets languages + * * @param \DocuSign\eSign\Model\NameValue[] $languages + * * @return $this */ public function setLanguages($languages) @@ -167,7 +229,9 @@ public function setLanguages($languages) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TabAccountSettings.php b/src/Model/TabAccountSettings.php index 0d44cda6..fe13980e 100644 --- a/src/Model/TabAccountSettings.php +++ b/src/Model/TabAccountSettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TabAccountSettings Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TabAccountSettings implements ArrayAccess +class TabAccountSettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'tabAccountSettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -96,13 +99,78 @@ class TabAccountSettings implements ArrayAccess 'text_tabs_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_tab_order' => null, + 'allow_tab_order_metadata' => null, + 'approve_decline_tabs_enabled' => null, + 'approve_decline_tabs_metadata' => null, + 'calculated_fields_enabled' => null, + 'calculated_fields_metadata' => null, + 'checkbox_tabs_enabled' => null, + 'check_box_tabs_metadata' => null, + 'data_field_regex_enabled' => null, + 'data_field_regex_metadata' => null, + 'data_field_size_enabled' => null, + 'data_field_size_metadata' => null, + 'draw_tabs_enabled' => null, + 'draw_tabs_metadata' => null, + 'first_last_email_tabs_enabled' => null, + 'first_last_email_tabs_metadata' => null, + 'list_tabs_enabled' => null, + 'list_tabs_metadata' => null, + 'note_tabs_enabled' => null, + 'note_tabs_metadata' => null, + 'radio_tabs_enabled' => null, + 'radio_tabs_metadata' => null, + 'saving_custom_tabs_enabled' => null, + 'saving_custom_tabs_metadata' => null, + 'sender_to_change_tab_assignments_enabled' => null, + 'sender_to_change_tab_assignments_metadata' => null, + 'shared_custom_tabs_enabled' => null, + 'shared_custom_tabs_metadata' => null, + 'tab_data_label_enabled' => null, + 'tab_data_label_metadata' => null, + 'tab_location_enabled' => null, + 'tab_location_metadata' => null, + 'tab_locking_enabled' => null, + 'tab_locking_metadata' => null, + 'tab_scale_enabled' => null, + 'tab_scale_metadata' => null, + 'tab_text_formatting_enabled' => null, + 'tab_text_formatting_metadata' => null, + 'text_tabs_enabled' => null, + 'text_tabs_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -148,9 +216,9 @@ public static function swaggerTypes() 'text_tabs_metadata' => 'textTabsMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -196,9 +264,9 @@ public static function swaggerTypes() 'text_tabs_metadata' => 'setTextTabsMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -244,34 +312,63 @@ public static function swaggerTypes() 'text_tabs_metadata' => 'getTextTabsMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -318,30 +415,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets allow_tab_order + * * @return string */ public function getAllowTabOrder() @@ -351,7 +450,9 @@ public function getAllowTabOrder() /** * Sets allow_tab_order + * * @param string $allow_tab_order + * * @return $this */ public function setAllowTabOrder($allow_tab_order) @@ -363,6 +464,7 @@ public function setAllowTabOrder($allow_tab_order) /** * Gets allow_tab_order_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowTabOrderMetadata() @@ -372,7 +474,9 @@ public function getAllowTabOrderMetadata() /** * Sets allow_tab_order_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_tab_order_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_tab_order_metadata allow_tab_order_metadata + * * @return $this */ public function setAllowTabOrderMetadata($allow_tab_order_metadata) @@ -384,6 +488,7 @@ public function setAllowTabOrderMetadata($allow_tab_order_metadata) /** * Gets approve_decline_tabs_enabled + * * @return string */ public function getApproveDeclineTabsEnabled() @@ -393,7 +498,9 @@ public function getApproveDeclineTabsEnabled() /** * Sets approve_decline_tabs_enabled + * * @param string $approve_decline_tabs_enabled + * * @return $this */ public function setApproveDeclineTabsEnabled($approve_decline_tabs_enabled) @@ -405,6 +512,7 @@ public function setApproveDeclineTabsEnabled($approve_decline_tabs_enabled) /** * Gets approve_decline_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getApproveDeclineTabsMetadata() @@ -414,7 +522,9 @@ public function getApproveDeclineTabsMetadata() /** * Sets approve_decline_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $approve_decline_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $approve_decline_tabs_metadata approve_decline_tabs_metadata + * * @return $this */ public function setApproveDeclineTabsMetadata($approve_decline_tabs_metadata) @@ -426,6 +536,7 @@ public function setApproveDeclineTabsMetadata($approve_decline_tabs_metadata) /** * Gets calculated_fields_enabled + * * @return string */ public function getCalculatedFieldsEnabled() @@ -435,7 +546,9 @@ public function getCalculatedFieldsEnabled() /** * Sets calculated_fields_enabled + * * @param string $calculated_fields_enabled + * * @return $this */ public function setCalculatedFieldsEnabled($calculated_fields_enabled) @@ -447,6 +560,7 @@ public function setCalculatedFieldsEnabled($calculated_fields_enabled) /** * Gets calculated_fields_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCalculatedFieldsMetadata() @@ -456,7 +570,9 @@ public function getCalculatedFieldsMetadata() /** * Sets calculated_fields_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $calculated_fields_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $calculated_fields_metadata calculated_fields_metadata + * * @return $this */ public function setCalculatedFieldsMetadata($calculated_fields_metadata) @@ -468,6 +584,7 @@ public function setCalculatedFieldsMetadata($calculated_fields_metadata) /** * Gets checkbox_tabs_enabled + * * @return string */ public function getCheckboxTabsEnabled() @@ -477,7 +594,9 @@ public function getCheckboxTabsEnabled() /** * Sets checkbox_tabs_enabled + * * @param string $checkbox_tabs_enabled + * * @return $this */ public function setCheckboxTabsEnabled($checkbox_tabs_enabled) @@ -489,6 +608,7 @@ public function setCheckboxTabsEnabled($checkbox_tabs_enabled) /** * Gets check_box_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCheckBoxTabsMetadata() @@ -498,7 +618,9 @@ public function getCheckBoxTabsMetadata() /** * Sets check_box_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $check_box_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $check_box_tabs_metadata check_box_tabs_metadata + * * @return $this */ public function setCheckBoxTabsMetadata($check_box_tabs_metadata) @@ -510,6 +632,7 @@ public function setCheckBoxTabsMetadata($check_box_tabs_metadata) /** * Gets data_field_regex_enabled + * * @return string */ public function getDataFieldRegexEnabled() @@ -519,7 +642,9 @@ public function getDataFieldRegexEnabled() /** * Sets data_field_regex_enabled + * * @param string $data_field_regex_enabled + * * @return $this */ public function setDataFieldRegexEnabled($data_field_regex_enabled) @@ -531,6 +656,7 @@ public function setDataFieldRegexEnabled($data_field_regex_enabled) /** * Gets data_field_regex_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDataFieldRegexMetadata() @@ -540,7 +666,9 @@ public function getDataFieldRegexMetadata() /** * Sets data_field_regex_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $data_field_regex_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $data_field_regex_metadata data_field_regex_metadata + * * @return $this */ public function setDataFieldRegexMetadata($data_field_regex_metadata) @@ -552,6 +680,7 @@ public function setDataFieldRegexMetadata($data_field_regex_metadata) /** * Gets data_field_size_enabled + * * @return string */ public function getDataFieldSizeEnabled() @@ -561,7 +690,9 @@ public function getDataFieldSizeEnabled() /** * Sets data_field_size_enabled + * * @param string $data_field_size_enabled + * * @return $this */ public function setDataFieldSizeEnabled($data_field_size_enabled) @@ -573,6 +704,7 @@ public function setDataFieldSizeEnabled($data_field_size_enabled) /** * Gets data_field_size_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDataFieldSizeMetadata() @@ -582,7 +714,9 @@ public function getDataFieldSizeMetadata() /** * Sets data_field_size_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $data_field_size_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $data_field_size_metadata data_field_size_metadata + * * @return $this */ public function setDataFieldSizeMetadata($data_field_size_metadata) @@ -594,6 +728,7 @@ public function setDataFieldSizeMetadata($data_field_size_metadata) /** * Gets draw_tabs_enabled + * * @return string */ public function getDrawTabsEnabled() @@ -603,7 +738,9 @@ public function getDrawTabsEnabled() /** * Sets draw_tabs_enabled + * * @param string $draw_tabs_enabled + * * @return $this */ public function setDrawTabsEnabled($draw_tabs_enabled) @@ -615,6 +752,7 @@ public function setDrawTabsEnabled($draw_tabs_enabled) /** * Gets draw_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDrawTabsMetadata() @@ -624,7 +762,9 @@ public function getDrawTabsMetadata() /** * Sets draw_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $draw_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $draw_tabs_metadata draw_tabs_metadata + * * @return $this */ public function setDrawTabsMetadata($draw_tabs_metadata) @@ -636,6 +776,7 @@ public function setDrawTabsMetadata($draw_tabs_metadata) /** * Gets first_last_email_tabs_enabled + * * @return string */ public function getFirstLastEmailTabsEnabled() @@ -645,7 +786,9 @@ public function getFirstLastEmailTabsEnabled() /** * Sets first_last_email_tabs_enabled + * * @param string $first_last_email_tabs_enabled + * * @return $this */ public function setFirstLastEmailTabsEnabled($first_last_email_tabs_enabled) @@ -657,6 +800,7 @@ public function setFirstLastEmailTabsEnabled($first_last_email_tabs_enabled) /** * Gets first_last_email_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getFirstLastEmailTabsMetadata() @@ -666,7 +810,9 @@ public function getFirstLastEmailTabsMetadata() /** * Sets first_last_email_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $first_last_email_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $first_last_email_tabs_metadata first_last_email_tabs_metadata + * * @return $this */ public function setFirstLastEmailTabsMetadata($first_last_email_tabs_metadata) @@ -678,6 +824,7 @@ public function setFirstLastEmailTabsMetadata($first_last_email_tabs_metadata) /** * Gets list_tabs_enabled + * * @return string */ public function getListTabsEnabled() @@ -687,7 +834,9 @@ public function getListTabsEnabled() /** * Sets list_tabs_enabled + * * @param string $list_tabs_enabled + * * @return $this */ public function setListTabsEnabled($list_tabs_enabled) @@ -699,6 +848,7 @@ public function setListTabsEnabled($list_tabs_enabled) /** * Gets list_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getListTabsMetadata() @@ -708,7 +858,9 @@ public function getListTabsMetadata() /** * Sets list_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $list_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $list_tabs_metadata list_tabs_metadata + * * @return $this */ public function setListTabsMetadata($list_tabs_metadata) @@ -720,6 +872,7 @@ public function setListTabsMetadata($list_tabs_metadata) /** * Gets note_tabs_enabled + * * @return string */ public function getNoteTabsEnabled() @@ -729,7 +882,9 @@ public function getNoteTabsEnabled() /** * Sets note_tabs_enabled + * * @param string $note_tabs_enabled + * * @return $this */ public function setNoteTabsEnabled($note_tabs_enabled) @@ -741,6 +896,7 @@ public function setNoteTabsEnabled($note_tabs_enabled) /** * Gets note_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getNoteTabsMetadata() @@ -750,7 +906,9 @@ public function getNoteTabsMetadata() /** * Sets note_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $note_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $note_tabs_metadata note_tabs_metadata + * * @return $this */ public function setNoteTabsMetadata($note_tabs_metadata) @@ -762,6 +920,7 @@ public function setNoteTabsMetadata($note_tabs_metadata) /** * Gets radio_tabs_enabled + * * @return string */ public function getRadioTabsEnabled() @@ -771,7 +930,9 @@ public function getRadioTabsEnabled() /** * Sets radio_tabs_enabled + * * @param string $radio_tabs_enabled + * * @return $this */ public function setRadioTabsEnabled($radio_tabs_enabled) @@ -783,6 +944,7 @@ public function setRadioTabsEnabled($radio_tabs_enabled) /** * Gets radio_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRadioTabsMetadata() @@ -792,7 +954,9 @@ public function getRadioTabsMetadata() /** * Sets radio_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $radio_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $radio_tabs_metadata radio_tabs_metadata + * * @return $this */ public function setRadioTabsMetadata($radio_tabs_metadata) @@ -804,6 +968,7 @@ public function setRadioTabsMetadata($radio_tabs_metadata) /** * Gets saving_custom_tabs_enabled + * * @return string */ public function getSavingCustomTabsEnabled() @@ -813,7 +978,9 @@ public function getSavingCustomTabsEnabled() /** * Sets saving_custom_tabs_enabled + * * @param string $saving_custom_tabs_enabled + * * @return $this */ public function setSavingCustomTabsEnabled($saving_custom_tabs_enabled) @@ -825,6 +992,7 @@ public function setSavingCustomTabsEnabled($saving_custom_tabs_enabled) /** * Gets saving_custom_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSavingCustomTabsMetadata() @@ -834,7 +1002,9 @@ public function getSavingCustomTabsMetadata() /** * Sets saving_custom_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $saving_custom_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $saving_custom_tabs_metadata saving_custom_tabs_metadata + * * @return $this */ public function setSavingCustomTabsMetadata($saving_custom_tabs_metadata) @@ -846,6 +1016,7 @@ public function setSavingCustomTabsMetadata($saving_custom_tabs_metadata) /** * Gets sender_to_change_tab_assignments_enabled + * * @return string */ public function getSenderToChangeTabAssignmentsEnabled() @@ -855,7 +1026,9 @@ public function getSenderToChangeTabAssignmentsEnabled() /** * Sets sender_to_change_tab_assignments_enabled + * * @param string $sender_to_change_tab_assignments_enabled + * * @return $this */ public function setSenderToChangeTabAssignmentsEnabled($sender_to_change_tab_assignments_enabled) @@ -867,6 +1040,7 @@ public function setSenderToChangeTabAssignmentsEnabled($sender_to_change_tab_ass /** * Gets sender_to_change_tab_assignments_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSenderToChangeTabAssignmentsMetadata() @@ -876,7 +1050,9 @@ public function getSenderToChangeTabAssignmentsMetadata() /** * Sets sender_to_change_tab_assignments_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $sender_to_change_tab_assignments_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $sender_to_change_tab_assignments_metadata sender_to_change_tab_assignments_metadata + * * @return $this */ public function setSenderToChangeTabAssignmentsMetadata($sender_to_change_tab_assignments_metadata) @@ -888,6 +1064,7 @@ public function setSenderToChangeTabAssignmentsMetadata($sender_to_change_tab_as /** * Gets shared_custom_tabs_enabled + * * @return string */ public function getSharedCustomTabsEnabled() @@ -897,7 +1074,9 @@ public function getSharedCustomTabsEnabled() /** * Sets shared_custom_tabs_enabled + * * @param string $shared_custom_tabs_enabled + * * @return $this */ public function setSharedCustomTabsEnabled($shared_custom_tabs_enabled) @@ -909,6 +1088,7 @@ public function setSharedCustomTabsEnabled($shared_custom_tabs_enabled) /** * Gets shared_custom_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSharedCustomTabsMetadata() @@ -918,7 +1098,9 @@ public function getSharedCustomTabsMetadata() /** * Sets shared_custom_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $shared_custom_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $shared_custom_tabs_metadata shared_custom_tabs_metadata + * * @return $this */ public function setSharedCustomTabsMetadata($shared_custom_tabs_metadata) @@ -930,6 +1112,7 @@ public function setSharedCustomTabsMetadata($shared_custom_tabs_metadata) /** * Gets tab_data_label_enabled + * * @return string */ public function getTabDataLabelEnabled() @@ -939,7 +1122,9 @@ public function getTabDataLabelEnabled() /** * Sets tab_data_label_enabled + * * @param string $tab_data_label_enabled + * * @return $this */ public function setTabDataLabelEnabled($tab_data_label_enabled) @@ -951,6 +1136,7 @@ public function setTabDataLabelEnabled($tab_data_label_enabled) /** * Gets tab_data_label_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabDataLabelMetadata() @@ -960,7 +1146,9 @@ public function getTabDataLabelMetadata() /** * Sets tab_data_label_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $tab_data_label_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $tab_data_label_metadata tab_data_label_metadata + * * @return $this */ public function setTabDataLabelMetadata($tab_data_label_metadata) @@ -972,6 +1160,7 @@ public function setTabDataLabelMetadata($tab_data_label_metadata) /** * Gets tab_location_enabled + * * @return string */ public function getTabLocationEnabled() @@ -981,7 +1170,9 @@ public function getTabLocationEnabled() /** * Sets tab_location_enabled + * * @param string $tab_location_enabled + * * @return $this */ public function setTabLocationEnabled($tab_location_enabled) @@ -993,6 +1184,7 @@ public function setTabLocationEnabled($tab_location_enabled) /** * Gets tab_location_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabLocationMetadata() @@ -1002,7 +1194,9 @@ public function getTabLocationMetadata() /** * Sets tab_location_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $tab_location_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $tab_location_metadata tab_location_metadata + * * @return $this */ public function setTabLocationMetadata($tab_location_metadata) @@ -1014,6 +1208,7 @@ public function setTabLocationMetadata($tab_location_metadata) /** * Gets tab_locking_enabled + * * @return string */ public function getTabLockingEnabled() @@ -1023,7 +1218,9 @@ public function getTabLockingEnabled() /** * Sets tab_locking_enabled + * * @param string $tab_locking_enabled + * * @return $this */ public function setTabLockingEnabled($tab_locking_enabled) @@ -1035,6 +1232,7 @@ public function setTabLockingEnabled($tab_locking_enabled) /** * Gets tab_locking_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabLockingMetadata() @@ -1044,7 +1242,9 @@ public function getTabLockingMetadata() /** * Sets tab_locking_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $tab_locking_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $tab_locking_metadata tab_locking_metadata + * * @return $this */ public function setTabLockingMetadata($tab_locking_metadata) @@ -1056,6 +1256,7 @@ public function setTabLockingMetadata($tab_locking_metadata) /** * Gets tab_scale_enabled + * * @return string */ public function getTabScaleEnabled() @@ -1065,7 +1266,9 @@ public function getTabScaleEnabled() /** * Sets tab_scale_enabled + * * @param string $tab_scale_enabled + * * @return $this */ public function setTabScaleEnabled($tab_scale_enabled) @@ -1077,6 +1280,7 @@ public function setTabScaleEnabled($tab_scale_enabled) /** * Gets tab_scale_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabScaleMetadata() @@ -1086,7 +1290,9 @@ public function getTabScaleMetadata() /** * Sets tab_scale_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $tab_scale_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $tab_scale_metadata tab_scale_metadata + * * @return $this */ public function setTabScaleMetadata($tab_scale_metadata) @@ -1098,6 +1304,7 @@ public function setTabScaleMetadata($tab_scale_metadata) /** * Gets tab_text_formatting_enabled + * * @return string */ public function getTabTextFormattingEnabled() @@ -1107,7 +1314,9 @@ public function getTabTextFormattingEnabled() /** * Sets tab_text_formatting_enabled + * * @param string $tab_text_formatting_enabled + * * @return $this */ public function setTabTextFormattingEnabled($tab_text_formatting_enabled) @@ -1119,6 +1328,7 @@ public function setTabTextFormattingEnabled($tab_text_formatting_enabled) /** * Gets tab_text_formatting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabTextFormattingMetadata() @@ -1128,7 +1338,9 @@ public function getTabTextFormattingMetadata() /** * Sets tab_text_formatting_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $tab_text_formatting_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $tab_text_formatting_metadata tab_text_formatting_metadata + * * @return $this */ public function setTabTextFormattingMetadata($tab_text_formatting_metadata) @@ -1140,6 +1352,7 @@ public function setTabTextFormattingMetadata($tab_text_formatting_metadata) /** * Gets text_tabs_enabled + * * @return string */ public function getTextTabsEnabled() @@ -1149,7 +1362,9 @@ public function getTextTabsEnabled() /** * Sets text_tabs_enabled + * * @param string $text_tabs_enabled + * * @return $this */ public function setTextTabsEnabled($text_tabs_enabled) @@ -1161,6 +1376,7 @@ public function setTextTabsEnabled($text_tabs_enabled) /** * Gets text_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTextTabsMetadata() @@ -1170,7 +1386,9 @@ public function getTextTabsMetadata() /** * Sets text_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $text_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $text_tabs_metadata text_tabs_metadata + * * @return $this */ public function setTextTabsMetadata($text_tabs_metadata) @@ -1181,7 +1399,9 @@ public function setTextTabsMetadata($text_tabs_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1191,7 +1411,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1201,8 +1423,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1216,7 +1440,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1226,16 +1452,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TabGroup.php b/src/Model/TabGroup.php index 9e1603ce..112b4588 100644 --- a/src/Model/TabGroup.php +++ b/src/Model/TabGroup.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TabGroup Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TabGroup implements ArrayAccess +class TabGroup implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'tabGroup'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -136,13 +139,118 @@ class TabGroup implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'group_label' => null, + 'group_label_metadata' => null, + 'group_rule' => null, + 'group_rule_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'maximum_allowed' => null, + 'maximum_allowed_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'minimum_required' => null, + 'minimum_required_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_scope' => null, + 'tab_scope_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'validation_message' => null, + 'validation_message_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -228,9 +336,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -316,9 +424,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -404,34 +512,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -518,30 +655,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -551,7 +690,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -563,6 +704,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -572,7 +714,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -584,6 +728,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -593,7 +738,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -605,6 +752,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -614,7 +762,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -626,6 +776,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -635,7 +786,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -647,6 +800,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -656,7 +810,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -668,6 +824,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -677,7 +834,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -689,6 +848,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -698,7 +858,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -710,6 +872,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -719,7 +882,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -731,6 +896,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -740,7 +906,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -752,6 +920,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -761,7 +930,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -773,6 +944,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -782,7 +954,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -794,6 +968,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -803,7 +978,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -815,6 +992,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -824,7 +1002,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -836,6 +1016,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -845,7 +1026,9 @@ public function getAnchorUnits() /** * 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) @@ -857,6 +1040,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -866,7 +1050,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -878,6 +1064,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -887,7 +1074,9 @@ public function getAnchorXOffset() /** * 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) @@ -899,6 +1088,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -908,7 +1098,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -920,6 +1112,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -929,7 +1122,9 @@ public function getAnchorYOffset() /** * 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) @@ -941,6 +1136,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -950,7 +1146,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -962,6 +1160,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -971,7 +1170,9 @@ public function getConditionalParentLabel() /** * 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) @@ -983,6 +1184,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -992,7 +1194,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1004,6 +1208,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1013,7 +1218,9 @@ public function getConditionalParentValue() /** * 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) @@ -1025,6 +1232,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1034,7 +1242,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1046,6 +1256,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1055,7 +1266,9 @@ public function getCustomTabId() /** * 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) @@ -1067,6 +1280,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1076,7 +1290,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1088,6 +1304,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1097,7 +1314,9 @@ public function getDocumentId() /** * 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) @@ -1109,6 +1328,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1118,7 +1338,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1130,6 +1352,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1139,7 +1362,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1151,6 +1376,7 @@ public function setErrorDetails($error_details) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1160,7 +1386,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1172,6 +1400,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1181,7 +1410,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1193,6 +1424,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1202,7 +1434,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1214,6 +1448,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1223,7 +1458,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1235,6 +1472,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1244,7 +1482,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1256,6 +1496,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1265,7 +1506,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1277,6 +1520,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets group_label + * * @return string */ public function getGroupLabel() @@ -1286,7 +1530,9 @@ public function getGroupLabel() /** * Sets group_label + * * @param string $group_label + * * @return $this */ public function setGroupLabel($group_label) @@ -1298,6 +1544,7 @@ public function setGroupLabel($group_label) /** * Gets group_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getGroupLabelMetadata() @@ -1307,7 +1554,9 @@ public function getGroupLabelMetadata() /** * Sets group_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $group_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $group_label_metadata group_label_metadata + * * @return $this */ public function setGroupLabelMetadata($group_label_metadata) @@ -1319,6 +1568,7 @@ public function setGroupLabelMetadata($group_label_metadata) /** * Gets group_rule + * * @return string */ public function getGroupRule() @@ -1328,7 +1578,9 @@ public function getGroupRule() /** * Sets group_rule + * * @param string $group_rule + * * @return $this */ public function setGroupRule($group_rule) @@ -1340,6 +1592,7 @@ public function setGroupRule($group_rule) /** * Gets group_rule_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getGroupRuleMetadata() @@ -1349,7 +1602,9 @@ public function getGroupRuleMetadata() /** * Sets group_rule_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $group_rule_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $group_rule_metadata group_rule_metadata + * * @return $this */ public function setGroupRuleMetadata($group_rule_metadata) @@ -1361,6 +1616,7 @@ public function setGroupRuleMetadata($group_rule_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1370,7 +1626,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1382,6 +1640,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1391,7 +1650,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1403,6 +1664,7 @@ public function setHeightMetadata($height_metadata) /** * Gets maximum_allowed + * * @return string */ public function getMaximumAllowed() @@ -1412,7 +1674,9 @@ public function getMaximumAllowed() /** * Sets maximum_allowed + * * @param string $maximum_allowed + * * @return $this */ public function setMaximumAllowed($maximum_allowed) @@ -1424,6 +1688,7 @@ public function setMaximumAllowed($maximum_allowed) /** * Gets maximum_allowed_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaximumAllowedMetadata() @@ -1433,7 +1698,9 @@ public function getMaximumAllowedMetadata() /** * Sets maximum_allowed_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $maximum_allowed_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $maximum_allowed_metadata maximum_allowed_metadata + * * @return $this */ public function setMaximumAllowedMetadata($maximum_allowed_metadata) @@ -1445,6 +1712,7 @@ public function setMaximumAllowedMetadata($maximum_allowed_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1454,7 +1722,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1466,6 +1736,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1475,7 +1746,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1487,6 +1760,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets minimum_required + * * @return string */ public function getMinimumRequired() @@ -1496,7 +1770,9 @@ public function getMinimumRequired() /** * Sets minimum_required + * * @param string $minimum_required + * * @return $this */ public function setMinimumRequired($minimum_required) @@ -1508,6 +1784,7 @@ public function setMinimumRequired($minimum_required) /** * Gets minimum_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMinimumRequiredMetadata() @@ -1517,7 +1794,9 @@ public function getMinimumRequiredMetadata() /** * Sets minimum_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $minimum_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $minimum_required_metadata minimum_required_metadata + * * @return $this */ public function setMinimumRequiredMetadata($minimum_required_metadata) @@ -1529,6 +1808,7 @@ public function setMinimumRequiredMetadata($minimum_required_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1538,7 +1818,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1550,6 +1832,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1559,7 +1842,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1571,6 +1856,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1580,7 +1866,9 @@ public function getRecipientId() /** * 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) @@ -1592,6 +1880,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1601,7 +1890,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1613,6 +1904,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1622,7 +1914,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1634,6 +1928,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1643,7 +1938,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1655,6 +1952,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1664,7 +1962,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1676,6 +1976,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1685,7 +1986,9 @@ public function getStatus() /** * 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) @@ -1697,6 +2000,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1706,7 +2010,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1718,6 +2024,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1727,7 +2034,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1739,6 +2048,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1748,7 +2058,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1760,6 +2072,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1769,7 +2082,9 @@ public function getTabId() /** * 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) @@ -1781,6 +2096,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1790,7 +2106,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -1802,6 +2120,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1811,7 +2130,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1823,6 +2144,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -1832,7 +2154,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -1844,6 +2168,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_scope + * * @return string */ public function getTabScope() @@ -1853,7 +2178,9 @@ public function getTabScope() /** * Sets tab_scope + * * @param string $tab_scope + * * @return $this */ public function setTabScope($tab_scope) @@ -1865,6 +2192,7 @@ public function setTabScope($tab_scope) /** * Gets tab_scope_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabScopeMetadata() @@ -1874,7 +2202,9 @@ public function getTabScopeMetadata() /** * Sets tab_scope_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_scope_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_scope_metadata tab_scope_metadata + * * @return $this */ public function setTabScopeMetadata($tab_scope_metadata) @@ -1886,6 +2216,7 @@ public function setTabScopeMetadata($tab_scope_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -1895,7 +2226,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -1907,6 +2240,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -1916,7 +2250,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -1928,6 +2264,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1937,7 +2274,9 @@ public function getTemplateLocked() /** * 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) @@ -1949,6 +2288,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -1958,7 +2298,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -1970,6 +2312,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1979,7 +2322,9 @@ public function getTemplateRequired() /** * 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) @@ -1991,6 +2336,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2000,7 +2346,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2012,6 +2360,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2021,7 +2370,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2033,6 +2384,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2042,7 +2394,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2054,6 +2408,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -2063,7 +2418,9 @@ public function getValidationMessage() /** * Sets validation_message + * * @param string $validation_message The message displayed if the custom tab fails input validation (either custom of embedded). + * * @return $this */ public function setValidationMessage($validation_message) @@ -2075,6 +2432,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_message_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationMessageMetadata() @@ -2084,7 +2442,9 @@ public function getValidationMessageMetadata() /** * Sets validation_message_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata validation_message_metadata + * * @return $this */ public function setValidationMessageMetadata($validation_message_metadata) @@ -2096,6 +2456,7 @@ public function setValidationMessageMetadata($validation_message_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2105,7 +2466,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2117,6 +2480,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2126,7 +2490,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2138,6 +2504,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2147,7 +2514,9 @@ public function getXPosition() /** * 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) @@ -2159,6 +2528,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2168,7 +2538,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2180,6 +2552,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2189,7 +2562,9 @@ public function getYPosition() /** * 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) @@ -2201,6 +2576,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2210,7 +2586,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2221,7 +2599,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2231,7 +2611,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2241,8 +2623,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2256,7 +2640,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2266,16 +2652,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TabMetadata.php b/src/Model/TabMetadata.php index e9e0c1ab..cace146f 100644 --- a/src/Model/TabMetadata.php +++ b/src/Model/TabMetadata.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TabMetadata Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TabMetadata implements ArrayAccess +class TabMetadata implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'tabMetadata'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,6 +66,7 @@ class TabMetadata implements ArrayAccess 'anchor_x_offset' => 'string', 'anchor_y_offset' => 'string', 'bold' => 'string', + 'collaborative' => 'string', 'conceal_value_on_document' => 'string', 'created_by_display_name' => 'string', 'created_by_user_id' => 'string', @@ -101,13 +105,84 @@ class TabMetadata implements ArrayAccess 'width' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor' => null, + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'collaborative' => null, + 'conceal_value_on_document' => null, + 'created_by_display_name' => null, + 'created_by_user_id' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'editable' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'height' => null, + 'included_in_email' => null, + 'initial_value' => null, + 'italic' => null, + 'items' => null, + 'last_modified' => null, + 'last_modified_by_display_name' => null, + 'last_modified_by_user_id' => null, + 'locked' => null, + 'maximum_length' => null, + 'merge_field' => null, + 'name' => null, + 'payment_item_code' => null, + 'payment_item_description' => null, + 'payment_item_name' => null, + 'required' => null, + 'scale_value' => null, + 'selected' => null, + 'shared' => null, + 'stamp_type' => null, + 'stamp_type_metadata' => null, + 'tab_label' => null, + 'type' => null, + 'underline' => null, + 'validation_message' => null, + 'validation_pattern' => null, + 'width' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -120,6 +195,7 @@ public static function swaggerTypes() 'anchor_x_offset' => 'anchorXOffset', 'anchor_y_offset' => 'anchorYOffset', 'bold' => 'bold', + 'collaborative' => 'collaborative', 'conceal_value_on_document' => 'concealValueOnDocument', 'created_by_display_name' => 'createdByDisplayName', 'created_by_user_id' => 'createdByUserId', @@ -158,9 +234,9 @@ public static function swaggerTypes() 'width' => 'width' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -173,6 +249,7 @@ public static function swaggerTypes() 'anchor_x_offset' => 'setAnchorXOffset', 'anchor_y_offset' => 'setAnchorYOffset', 'bold' => 'setBold', + 'collaborative' => 'setCollaborative', 'conceal_value_on_document' => 'setConcealValueOnDocument', 'created_by_display_name' => 'setCreatedByDisplayName', 'created_by_user_id' => 'setCreatedByUserId', @@ -211,9 +288,9 @@ public static function swaggerTypes() 'width' => 'setWidth' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -226,6 +303,7 @@ public static function swaggerTypes() 'anchor_x_offset' => 'getAnchorXOffset', 'anchor_y_offset' => 'getAnchorYOffset', 'bold' => 'getBold', + 'collaborative' => 'getCollaborative', 'conceal_value_on_document' => 'getConcealValueOnDocument', 'created_by_display_name' => 'getCreatedByDisplayName', 'created_by_user_id' => 'getCreatedByUserId', @@ -264,34 +342,63 @@ public static function swaggerTypes() 'width' => 'getWidth' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -304,6 +411,7 @@ public function __construct(array $data = 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['bold'] = isset($data['bold']) ? $data['bold'] : null; + $this->container['collaborative'] = isset($data['collaborative']) ? $data['collaborative'] : null; $this->container['conceal_value_on_document'] = isset($data['conceal_value_on_document']) ? $data['conceal_value_on_document'] : null; $this->container['created_by_display_name'] = isset($data['created_by_display_name']) ? $data['created_by_display_name'] : null; $this->container['created_by_user_id'] = isset($data['created_by_user_id']) ? $data['created_by_user_id'] : null; @@ -343,30 +451,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor + * * @return string */ public function getAnchor() @@ -376,7 +486,9 @@ public function getAnchor() /** * Sets anchor + * * @param string $anchor An optional string that is used to auto-match tabs to strings located in the documents of an envelope. + * * @return $this */ public function setAnchor($anchor) @@ -388,6 +500,7 @@ public function setAnchor($anchor) /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -397,7 +510,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -409,6 +524,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -418,7 +534,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -430,6 +548,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -439,7 +558,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -451,6 +572,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -460,7 +582,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -472,6 +596,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -481,7 +606,9 @@ public function getAnchorUnits() /** * 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) @@ -493,6 +620,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -502,7 +630,9 @@ public function getAnchorXOffset() /** * 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) @@ -514,6 +644,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -523,7 +654,9 @@ public function getAnchorYOffset() /** * 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) @@ -535,6 +668,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -544,7 +678,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -554,8 +690,33 @@ public function setBold($bold) return $this; } + /** + * Gets collaborative + * + * @return string + */ + public function getCollaborative() + { + return $this->container['collaborative']; + } + + /** + * Sets collaborative + * + * @param string $collaborative + * + * @return $this + */ + public function setCollaborative($collaborative) + { + $this->container['collaborative'] = $collaborative; + + return $this; + } + /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -565,7 +726,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -577,6 +740,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets created_by_display_name + * * @return string */ public function getCreatedByDisplayName() @@ -586,7 +750,9 @@ public function getCreatedByDisplayName() /** * Sets created_by_display_name + * * @param string $created_by_display_name The user name of the DocuSign user who created this object. + * * @return $this */ public function setCreatedByDisplayName($created_by_display_name) @@ -598,6 +764,7 @@ public function setCreatedByDisplayName($created_by_display_name) /** * Gets created_by_user_id + * * @return string */ public function getCreatedByUserId() @@ -607,7 +774,9 @@ public function getCreatedByUserId() /** * Sets created_by_user_id + * * @param string $created_by_user_id The userId of the DocuSign user who created this object. + * * @return $this */ public function setCreatedByUserId($created_by_user_id) @@ -619,6 +788,7 @@ public function setCreatedByUserId($created_by_user_id) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -628,7 +798,9 @@ public function getCustomTabId() /** * 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) @@ -640,6 +812,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -649,7 +822,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -661,6 +836,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets editable + * * @return string */ public function getEditable() @@ -670,7 +846,9 @@ public function getEditable() /** * Sets editable + * * @param string $editable When set to **true**, the custom tab is editable. Otherwise the custom tab cannot be modified. + * * @return $this */ public function setEditable($editable) @@ -682,6 +860,7 @@ public function setEditable($editable) /** * Gets font + * * @return string */ public function getFont() @@ -691,7 +870,9 @@ public function getFont() /** * 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) @@ -703,6 +884,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -712,7 +894,9 @@ public function getFontColor() /** * 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) @@ -724,6 +908,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -733,7 +918,9 @@ public function getFontSize() /** * 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) @@ -745,6 +932,7 @@ public function setFontSize($font_size) /** * Gets height + * * @return string */ public function getHeight() @@ -754,7 +942,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -766,6 +956,7 @@ public function setHeight($height) /** * Gets included_in_email + * * @return string */ public function getIncludedInEmail() @@ -775,7 +966,9 @@ public function getIncludedInEmail() /** * Sets included_in_email + * * @param string $included_in_email When set to **true**, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs. + * * @return $this */ public function setIncludedInEmail($included_in_email) @@ -787,6 +980,7 @@ public function setIncludedInEmail($included_in_email) /** * Gets initial_value + * * @return string */ public function getInitialValue() @@ -796,7 +990,9 @@ public function getInitialValue() /** * Sets initial_value + * * @param string $initial_value The original value of the tab. + * * @return $this */ public function setInitialValue($initial_value) @@ -808,6 +1004,7 @@ public function setInitialValue($initial_value) /** * Gets italic + * * @return string */ public function getItalic() @@ -817,7 +1014,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -829,6 +1028,7 @@ public function setItalic($italic) /** * Gets items + * * @return string[] */ public function getItems() @@ -838,7 +1038,9 @@ public function getItems() /** * Sets items + * * @param string[] $items If the tab is a list, this represents the values that are possible for the tab. + * * @return $this */ public function setItems($items) @@ -850,6 +1052,7 @@ public function setItems($items) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -859,7 +1062,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified The UTC DateTime this object was last modified. This is in ISO8601 format. + * * @return $this */ public function setLastModified($last_modified) @@ -871,6 +1076,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_by_display_name + * * @return string */ public function getLastModifiedByDisplayName() @@ -880,7 +1086,9 @@ public function getLastModifiedByDisplayName() /** * Sets last_modified_by_display_name + * * @param string $last_modified_by_display_name The User Name of the DocuSign user who last modified this object. + * * @return $this */ public function setLastModifiedByDisplayName($last_modified_by_display_name) @@ -892,6 +1100,7 @@ public function setLastModifiedByDisplayName($last_modified_by_display_name) /** * Gets last_modified_by_user_id + * * @return string */ public function getLastModifiedByUserId() @@ -901,7 +1110,9 @@ public function getLastModifiedByUserId() /** * Sets last_modified_by_user_id + * * @param string $last_modified_by_user_id The userId of the DocuSign user who last modified this object. + * * @return $this */ public function setLastModifiedByUserId($last_modified_by_user_id) @@ -913,6 +1124,7 @@ public function setLastModifiedByUserId($last_modified_by_user_id) /** * Gets locked + * * @return string */ public function getLocked() @@ -922,7 +1134,9 @@ public function getLocked() /** * 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) @@ -934,6 +1148,7 @@ public function setLocked($locked) /** * Gets maximum_length + * * @return string */ public function getMaximumLength() @@ -943,7 +1158,9 @@ public function getMaximumLength() /** * Sets maximum_length + * * @param string $maximum_length The maximum number of entry characters supported by the custom tab. + * * @return $this */ public function setMaximumLength($maximum_length) @@ -955,6 +1172,7 @@ public function setMaximumLength($maximum_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -964,7 +1182,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -976,6 +1196,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -985,7 +1206,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -997,6 +1220,7 @@ public function setName($name) /** * Gets payment_item_code + * * @return string */ public function getPaymentItemCode() @@ -1006,7 +1230,9 @@ public function getPaymentItemCode() /** * Sets payment_item_code + * * @param string $payment_item_code + * * @return $this */ public function setPaymentItemCode($payment_item_code) @@ -1018,6 +1244,7 @@ public function setPaymentItemCode($payment_item_code) /** * Gets payment_item_description + * * @return string */ public function getPaymentItemDescription() @@ -1027,7 +1254,9 @@ public function getPaymentItemDescription() /** * Sets payment_item_description + * * @param string $payment_item_description + * * @return $this */ public function setPaymentItemDescription($payment_item_description) @@ -1039,6 +1268,7 @@ public function setPaymentItemDescription($payment_item_description) /** * Gets payment_item_name + * * @return string */ public function getPaymentItemName() @@ -1048,7 +1278,9 @@ public function getPaymentItemName() /** * Sets payment_item_name + * * @param string $payment_item_name + * * @return $this */ public function setPaymentItemName($payment_item_name) @@ -1060,6 +1292,7 @@ public function setPaymentItemName($payment_item_name) /** * Gets required + * * @return string */ public function getRequired() @@ -1069,7 +1302,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -1081,6 +1316,7 @@ public function setRequired($required) /** * Gets scale_value + * * @return string */ public function getScaleValue() @@ -1090,7 +1326,9 @@ public function getScaleValue() /** * Sets scale_value + * * @param string $scale_value + * * @return $this */ public function setScaleValue($scale_value) @@ -1102,6 +1340,7 @@ public function setScaleValue($scale_value) /** * Gets selected + * * @return string */ public function getSelected() @@ -1111,7 +1350,9 @@ public function getSelected() /** * Sets selected + * * @param string $selected + * * @return $this */ public function setSelected($selected) @@ -1123,6 +1364,7 @@ public function setSelected($selected) /** * Gets shared + * * @return string */ public function getShared() @@ -1132,7 +1374,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1144,6 +1388,7 @@ public function setShared($shared) /** * Gets stamp_type + * * @return string */ public function getStampType() @@ -1153,7 +1398,9 @@ public function getStampType() /** * Sets stamp_type + * * @param string $stamp_type + * * @return $this */ public function setStampType($stamp_type) @@ -1165,6 +1412,7 @@ public function setStampType($stamp_type) /** * Gets stamp_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStampTypeMetadata() @@ -1174,7 +1422,9 @@ public function getStampTypeMetadata() /** * Sets stamp_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $stamp_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $stamp_type_metadata stamp_type_metadata + * * @return $this */ public function setStampTypeMetadata($stamp_type_metadata) @@ -1186,6 +1436,7 @@ public function setStampTypeMetadata($stamp_type_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1195,7 +1446,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -1207,6 +1460,7 @@ public function setTabLabel($tab_label) /** * Gets type + * * @return string */ public function getType() @@ -1216,7 +1470,9 @@ public function getType() /** * Sets type + * * @param string $type The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4. + * * @return $this */ public function setType($type) @@ -1228,6 +1484,7 @@ public function setType($type) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1237,7 +1494,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -1249,6 +1508,7 @@ public function setUnderline($underline) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -1258,7 +1518,9 @@ public function getValidationMessage() /** * Sets validation_message + * * @param string $validation_message The message displayed if the custom tab fails input validation (either custom of embedded). + * * @return $this */ public function setValidationMessage($validation_message) @@ -1270,6 +1532,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -1279,7 +1542,9 @@ public function getValidationPattern() /** * Sets validation_pattern + * * @param string $validation_pattern A regular expression used to validate input for the tab. + * * @return $this */ public function setValidationPattern($validation_pattern) @@ -1291,6 +1556,7 @@ public function setValidationPattern($validation_pattern) /** * Gets width + * * @return string */ public function getWidth() @@ -1300,7 +1566,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1311,7 +1579,9 @@ public function setWidth($width) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1321,7 +1591,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1331,8 +1603,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1346,7 +1620,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1356,16 +1632,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TabMetadataList.php b/src/Model/TabMetadataList.php index e4e7b2ad..854de00e 100644 --- a/src/Model/TabMetadataList.php +++ b/src/Model/TabMetadataList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TabMetadataList Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TabMetadataList implements ArrayAccess +class TabMetadataList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'tabMetadataList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'tabs' => '\DocuSign\eSign\Model\TabMetadata[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'tabs' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'tabs' => 'tabs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'tabs' => 'setTabs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'tabs' => 'getTabs' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets tabs + * * @return \DocuSign\eSign\Model\TabMetadata[] */ public function getTabs() @@ -156,7 +216,9 @@ public function getTabs() /** * Sets tabs + * * @param \DocuSign\eSign\Model\TabMetadata[] $tabs + * * @return $this */ public function setTabs($tabs) @@ -167,7 +229,9 @@ public function setTabs($tabs) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Tabs.php b/src/Model/Tabs.php index b77770ae..74cfa133 100644 --- a/src/Model/Tabs.php +++ b/src/Model/Tabs.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Tabs Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Tabs implements ArrayAccess +class Tabs implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'tabs'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -87,13 +90,69 @@ class Tabs implements ArrayAccess 'zip_tabs' => '\DocuSign\eSign\Model\Zip[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'approve_tabs' => null, + 'checkbox_tabs' => null, + 'comment_thread_tabs' => null, + 'company_tabs' => null, + 'date_signed_tabs' => null, + 'date_tabs' => null, + 'decline_tabs' => null, + 'draw_tabs' => null, + 'email_address_tabs' => null, + 'email_tabs' => null, + 'envelope_id_tabs' => null, + 'first_name_tabs' => null, + 'formula_tabs' => null, + 'full_name_tabs' => null, + 'initial_here_tabs' => null, + 'last_name_tabs' => null, + 'list_tabs' => null, + 'notarize_tabs' => null, + 'note_tabs' => null, + 'number_tabs' => null, + 'poly_line_overlay_tabs' => null, + 'radio_group_tabs' => null, + 'signer_attachment_tabs' => null, + 'sign_here_tabs' => null, + 'smart_section_tabs' => null, + 'ssn_tabs' => null, + 'tab_groups' => null, + 'text_tabs' => null, + 'title_tabs' => null, + 'view_tabs' => null, + 'zip_tabs' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -130,9 +189,9 @@ public static function swaggerTypes() 'zip_tabs' => 'zipTabs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -169,9 +228,9 @@ public static function swaggerTypes() 'zip_tabs' => 'setZipTabs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -208,34 +267,63 @@ public static function swaggerTypes() 'zip_tabs' => 'getZipTabs' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -273,30 +361,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets approve_tabs + * * @return \DocuSign\eSign\Model\Approve[] */ public function getApproveTabs() @@ -306,7 +396,9 @@ public function getApproveTabs() /** * Sets approve_tabs + * * @param \DocuSign\eSign\Model\Approve[] $approve_tabs Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. + * * @return $this */ public function setApproveTabs($approve_tabs) @@ -318,6 +410,7 @@ public function setApproveTabs($approve_tabs) /** * Gets checkbox_tabs + * * @return \DocuSign\eSign\Model\Checkbox[] */ public function getCheckboxTabs() @@ -327,7 +420,9 @@ public function getCheckboxTabs() /** * Sets checkbox_tabs + * * @param \DocuSign\eSign\Model\Checkbox[] $checkbox_tabs Specifies a tag on the document in a location where the recipient can select an option. + * * @return $this */ public function setCheckboxTabs($checkbox_tabs) @@ -339,6 +434,7 @@ public function setCheckboxTabs($checkbox_tabs) /** * Gets comment_thread_tabs + * * @return \DocuSign\eSign\Model\CommentThread[] */ public function getCommentThreadTabs() @@ -348,7 +444,9 @@ public function getCommentThreadTabs() /** * Sets comment_thread_tabs + * * @param \DocuSign\eSign\Model\CommentThread[] $comment_thread_tabs + * * @return $this */ public function setCommentThreadTabs($comment_thread_tabs) @@ -360,6 +458,7 @@ public function setCommentThreadTabs($comment_thread_tabs) /** * Gets company_tabs + * * @return \DocuSign\eSign\Model\Company[] */ public function getCompanyTabs() @@ -369,7 +468,9 @@ public function getCompanyTabs() /** * Sets company_tabs + * * @param \DocuSign\eSign\Model\Company[] $company_tabs Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setCompanyTabs($company_tabs) @@ -381,6 +482,7 @@ public function setCompanyTabs($company_tabs) /** * Gets date_signed_tabs + * * @return \DocuSign\eSign\Model\DateSigned[] */ public function getDateSignedTabs() @@ -390,7 +492,9 @@ public function getDateSignedTabs() /** * Sets date_signed_tabs + * * @param \DocuSign\eSign\Model\DateSigned[] $date_signed_tabs Specifies a tab on the document where the date the document was signed will automatically appear. + * * @return $this */ public function setDateSignedTabs($date_signed_tabs) @@ -402,6 +506,7 @@ public function setDateSignedTabs($date_signed_tabs) /** * Gets date_tabs + * * @return \DocuSign\eSign\Model\\DateTime[] */ public function getDateTabs() @@ -411,7 +516,9 @@ public function getDateTabs() /** * Sets date_tabs + * * @param \DocuSign\eSign\Model\\DateTime[] $date_tabs Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. + * * @return $this */ public function setDateTabs($date_tabs) @@ -423,6 +530,7 @@ public function setDateTabs($date_tabs) /** * Gets decline_tabs + * * @return \DocuSign\eSign\Model\Decline[] */ public function getDeclineTabs() @@ -432,7 +540,9 @@ public function getDeclineTabs() /** * Sets decline_tabs + * * @param \DocuSign\eSign\Model\Decline[] $decline_tabs Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. + * * @return $this */ public function setDeclineTabs($decline_tabs) @@ -444,6 +554,7 @@ public function setDeclineTabs($decline_tabs) /** * Gets draw_tabs + * * @return \DocuSign\eSign\Model\Draw[] */ public function getDrawTabs() @@ -453,7 +564,9 @@ public function getDrawTabs() /** * Sets draw_tabs + * * @param \DocuSign\eSign\Model\Draw[] $draw_tabs + * * @return $this */ public function setDrawTabs($draw_tabs) @@ -465,6 +578,7 @@ public function setDrawTabs($draw_tabs) /** * Gets email_address_tabs + * * @return \DocuSign\eSign\Model\EmailAddress[] */ public function getEmailAddressTabs() @@ -474,7 +588,9 @@ 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. + * * @return $this */ public function setEmailAddressTabs($email_address_tabs) @@ -486,6 +602,7 @@ public function setEmailAddressTabs($email_address_tabs) /** * Gets email_tabs + * * @return \DocuSign\eSign\Model\Email[] */ public function getEmailTabs() @@ -495,7 +612,9 @@ public function getEmailTabs() /** * Sets email_tabs + * * @param \DocuSign\eSign\Model\Email[] $email_tabs Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setEmailTabs($email_tabs) @@ -507,6 +626,7 @@ public function setEmailTabs($email_tabs) /** * Gets envelope_id_tabs + * * @return \DocuSign\eSign\Model\EnvelopeId[] */ public function getEnvelopeIdTabs() @@ -516,7 +636,9 @@ public function getEnvelopeIdTabs() /** * Sets envelope_id_tabs + * * @param \DocuSign\eSign\Model\EnvelopeId[] $envelope_id_tabs Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. + * * @return $this */ public function setEnvelopeIdTabs($envelope_id_tabs) @@ -528,6 +650,7 @@ public function setEnvelopeIdTabs($envelope_id_tabs) /** * Gets first_name_tabs + * * @return \DocuSign\eSign\Model\FirstName[] */ public function getFirstNameTabs() @@ -537,7 +660,9 @@ public function getFirstNameTabs() /** * Sets first_name_tabs + * * @param \DocuSign\eSign\Model\FirstName[] $first_name_tabs Specifies tag on a document where you want the recipient's first 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 first section as the first name. + * * @return $this */ public function setFirstNameTabs($first_name_tabs) @@ -549,6 +674,7 @@ public function setFirstNameTabs($first_name_tabs) /** * Gets formula_tabs + * * @return \DocuSign\eSign\Model\FormulaTab[] */ public function getFormulaTabs() @@ -558,7 +684,9 @@ public function getFormulaTabs() /** * Sets formula_tabs + * * @param \DocuSign\eSign\Model\FormulaTab[] $formula_tabs Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the \"formula\" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas. + * * @return $this */ public function setFormulaTabs($formula_tabs) @@ -570,6 +698,7 @@ public function setFormulaTabs($formula_tabs) /** * Gets full_name_tabs + * * @return \DocuSign\eSign\Model\FullName[] */ public function getFullNameTabs() @@ -579,7 +708,9 @@ public function getFullNameTabs() /** * Sets full_name_tabs + * * @param \DocuSign\eSign\Model\FullName[] $full_name_tabs Specifies a tag on the document where you want the recipient's name to appear. + * * @return $this */ public function setFullNameTabs($full_name_tabs) @@ -591,6 +722,7 @@ public function setFullNameTabs($full_name_tabs) /** * Gets initial_here_tabs + * * @return \DocuSign\eSign\Model\InitialHere[] */ public function getInitialHereTabs() @@ -600,7 +732,9 @@ public function getInitialHereTabs() /** * Sets initial_here_tabs + * * @param \DocuSign\eSign\Model\InitialHere[] $initial_here_tabs Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional. + * * @return $this */ public function setInitialHereTabs($initial_here_tabs) @@ -612,6 +746,7 @@ public function setInitialHereTabs($initial_here_tabs) /** * Gets last_name_tabs + * * @return \DocuSign\eSign\Model\LastName[] */ public function getLastNameTabs() @@ -621,7 +756,9 @@ 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. + * * @return $this */ public function setLastNameTabs($last_name_tabs) @@ -633,6 +770,7 @@ public function setLastNameTabs($last_name_tabs) /** * Gets list_tabs + * * @return \DocuSign\eSign\Model\array[] */ public function getListTabs() @@ -642,7 +780,9 @@ public function getListTabs() /** * Sets list_tabs + * * @param \DocuSign\eSign\Model\array[] $list_tabs Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. + * * @return $this */ public function setListTabs($list_tabs) @@ -654,6 +794,7 @@ public function setListTabs($list_tabs) /** * Gets notarize_tabs + * * @return \DocuSign\eSign\Model\Notarize[] */ public function getNotarizeTabs() @@ -663,7 +804,9 @@ public function getNotarizeTabs() /** * Sets notarize_tabs + * * @param \DocuSign\eSign\Model\Notarize[] $notarize_tabs + * * @return $this */ public function setNotarizeTabs($notarize_tabs) @@ -675,6 +818,7 @@ public function setNotarizeTabs($notarize_tabs) /** * Gets note_tabs + * * @return \DocuSign\eSign\Model\Note[] */ public function getNoteTabs() @@ -684,7 +828,9 @@ public function getNoteTabs() /** * Sets note_tabs + * * @param \DocuSign\eSign\Model\Note[] $note_tabs Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient. + * * @return $this */ public function setNoteTabs($note_tabs) @@ -696,6 +842,7 @@ public function setNoteTabs($note_tabs) /** * Gets number_tabs + * * @return \DocuSign\eSign\Model\Number[] */ public function getNumberTabs() @@ -705,7 +852,9 @@ public function getNumberTabs() /** * Sets number_tabs + * * @param \DocuSign\eSign\Model\Number[] $number_tabs Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setNumberTabs($number_tabs) @@ -717,6 +866,7 @@ public function setNumberTabs($number_tabs) /** * Gets poly_line_overlay_tabs + * * @return \DocuSign\eSign\Model\PolyLineOverlay[] */ public function getPolyLineOverlayTabs() @@ -726,7 +876,9 @@ public function getPolyLineOverlayTabs() /** * Sets poly_line_overlay_tabs + * * @param \DocuSign\eSign\Model\PolyLineOverlay[] $poly_line_overlay_tabs + * * @return $this */ public function setPolyLineOverlayTabs($poly_line_overlay_tabs) @@ -738,6 +890,7 @@ public function setPolyLineOverlayTabs($poly_line_overlay_tabs) /** * Gets radio_group_tabs + * * @return \DocuSign\eSign\Model\RadioGroup[] */ public function getRadioGroupTabs() @@ -747,7 +900,9 @@ public function getRadioGroupTabs() /** * Sets radio_group_tabs + * * @param \DocuSign\eSign\Model\RadioGroup[] $radio_group_tabs Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. + * * @return $this */ public function setRadioGroupTabs($radio_group_tabs) @@ -759,6 +914,7 @@ public function setRadioGroupTabs($radio_group_tabs) /** * Gets signer_attachment_tabs + * * @return \DocuSign\eSign\Model\SignerAttachment[] */ public function getSignerAttachmentTabs() @@ -768,7 +924,9 @@ public function getSignerAttachmentTabs() /** * Sets signer_attachment_tabs + * * @param \DocuSign\eSign\Model\SignerAttachment[] $signer_attachment_tabs Specifies a tag on the document when you want the recipient to add supporting documents to an envelope. + * * @return $this */ public function setSignerAttachmentTabs($signer_attachment_tabs) @@ -780,6 +938,7 @@ public function setSignerAttachmentTabs($signer_attachment_tabs) /** * Gets sign_here_tabs + * * @return \DocuSign\eSign\Model\SignHere[] */ public function getSignHereTabs() @@ -789,7 +948,9 @@ public function getSignHereTabs() /** * Sets sign_here_tabs + * * @param \DocuSign\eSign\Model\SignHere[] $sign_here_tabs A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The \"optional\" parameter sets if the signature is required or optional. + * * @return $this */ public function setSignHereTabs($sign_here_tabs) @@ -801,6 +962,7 @@ public function setSignHereTabs($sign_here_tabs) /** * Gets smart_section_tabs + * * @return \DocuSign\eSign\Model\SmartSection[] */ public function getSmartSectionTabs() @@ -810,7 +972,9 @@ public function getSmartSectionTabs() /** * Sets smart_section_tabs + * * @param \DocuSign\eSign\Model\SmartSection[] $smart_section_tabs + * * @return $this */ public function setSmartSectionTabs($smart_section_tabs) @@ -822,6 +986,7 @@ public function setSmartSectionTabs($smart_section_tabs) /** * Gets ssn_tabs + * * @return \DocuSign\eSign\Model\Ssn[] */ public function getSsnTabs() @@ -831,7 +996,9 @@ public function getSsnTabs() /** * Sets ssn_tabs + * * @param \DocuSign\eSign\Model\Ssn[] $ssn_tabs Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setSsnTabs($ssn_tabs) @@ -843,6 +1010,7 @@ public function setSsnTabs($ssn_tabs) /** * Gets tab_groups + * * @return \DocuSign\eSign\Model\TabGroup[] */ public function getTabGroups() @@ -852,7 +1020,9 @@ public function getTabGroups() /** * Sets tab_groups + * * @param \DocuSign\eSign\Model\TabGroup[] $tab_groups + * * @return $this */ public function setTabGroups($tab_groups) @@ -864,6 +1034,7 @@ public function setTabGroups($tab_groups) /** * Gets text_tabs + * * @return \DocuSign\eSign\Model\Text[] */ public function getTextTabs() @@ -873,7 +1044,9 @@ public function getTextTabs() /** * Sets text_tabs + * * @param \DocuSign\eSign\Model\Text[] $text_tabs Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setTextTabs($text_tabs) @@ -885,6 +1058,7 @@ public function setTextTabs($text_tabs) /** * Gets title_tabs + * * @return \DocuSign\eSign\Model\Title[] */ public function getTitleTabs() @@ -894,7 +1068,9 @@ public function getTitleTabs() /** * Sets title_tabs + * * @param \DocuSign\eSign\Model\Title[] $title_tabs Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setTitleTabs($title_tabs) @@ -906,6 +1082,7 @@ public function setTitleTabs($title_tabs) /** * Gets view_tabs + * * @return \DocuSign\eSign\Model\View[] */ public function getViewTabs() @@ -915,7 +1092,9 @@ public function getViewTabs() /** * Sets view_tabs + * * @param \DocuSign\eSign\Model\View[] $view_tabs + * * @return $this */ public function setViewTabs($view_tabs) @@ -927,6 +1106,7 @@ public function setViewTabs($view_tabs) /** * Gets zip_tabs + * * @return \DocuSign\eSign\Model\Zip[] */ public function getZipTabs() @@ -936,7 +1116,9 @@ public function getZipTabs() /** * Sets zip_tabs + * * @param \DocuSign\eSign\Model\Zip[] $zip_tabs Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setZipTabs($zip_tabs) @@ -947,7 +1129,9 @@ public function setZipTabs($zip_tabs) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -957,7 +1141,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -967,8 +1153,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -982,7 +1170,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -992,16 +1182,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateCustomFields.php b/src/Model/TemplateCustomFields.php index 6a22a6ca..9003ef37 100644 --- a/src/Model/TemplateCustomFields.php +++ b/src/Model/TemplateCustomFields.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateCustomFields Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateCustomFields implements ArrayAccess +class TemplateCustomFields implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateCustomFields'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class TemplateCustomFields implements ArrayAccess 'text_custom_fields' => '\DocuSign\eSign\Model\TextCustomField[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'list_custom_fields' => null, + 'text_custom_fields' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'text_custom_fields' => 'textCustomFields' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'text_custom_fields' => 'setTextCustomFields' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'text_custom_fields' => 'getTextCustomFields' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets list_custom_fields + * * @return \DocuSign\eSign\Model\ListCustomField[] */ public function getListCustomFields() @@ -161,7 +222,9 @@ public function getListCustomFields() /** * Sets list_custom_fields + * * @param \DocuSign\eSign\Model\ListCustomField[] $list_custom_fields An array of list custom fields. + * * @return $this */ public function setListCustomFields($list_custom_fields) @@ -173,6 +236,7 @@ public function setListCustomFields($list_custom_fields) /** * Gets text_custom_fields + * * @return \DocuSign\eSign\Model\TextCustomField[] */ public function getTextCustomFields() @@ -182,7 +246,9 @@ public function getTextCustomFields() /** * Sets text_custom_fields + * * @param \DocuSign\eSign\Model\TextCustomField[] $text_custom_fields An array of text custom fields. + * * @return $this */ public function setTextCustomFields($text_custom_fields) @@ -193,7 +259,9 @@ public function setTextCustomFields($text_custom_fields) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateDocumentVisibilityList.php b/src/Model/TemplateDocumentVisibilityList.php index 9e347c8c..9e88aeb8 100644 --- a/src/Model/TemplateDocumentVisibilityList.php +++ b/src/Model/TemplateDocumentVisibilityList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateDocumentVisibilityList Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateDocumentVisibilityList implements ArrayAccess +class TemplateDocumentVisibilityList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateDocumentVisibilityList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'document_visibility' => '\DocuSign\eSign\Model\DocumentVisibility[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'document_visibility' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'document_visibility' => 'documentVisibility' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'document_visibility' => 'setDocumentVisibility' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'document_visibility' => 'getDocumentVisibility' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -156,7 +216,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -167,7 +229,9 @@ public function setDocumentVisibility($document_visibility) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateDocumentsResult.php b/src/Model/TemplateDocumentsResult.php index 495cd607..a5d116bd 100644 --- a/src/Model/TemplateDocumentsResult.php +++ b/src/Model/TemplateDocumentsResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateDocumentsResult Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateDocumentsResult implements ArrayAccess +class TemplateDocumentsResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateDocumentsResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class TemplateDocumentsResult implements ArrayAccess 'template_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'template_documents' => null, + 'template_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'template_id' => 'templateId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'template_id' => 'setTemplateId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'template_id' => 'getTemplateId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets template_documents + * * @return \DocuSign\eSign\Model\EnvelopeDocument[] */ public function getTemplateDocuments() @@ -161,7 +222,9 @@ public function getTemplateDocuments() /** * Sets template_documents + * * @param \DocuSign\eSign\Model\EnvelopeDocument[] $template_documents + * * @return $this */ public function setTemplateDocuments($template_documents) @@ -173,6 +236,7 @@ public function setTemplateDocuments($template_documents) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -182,7 +246,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -193,7 +259,9 @@ public function setTemplateId($template_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateInformation.php b/src/Model/TemplateInformation.php index 51984411..fee31725 100644 --- a/src/Model/TemplateInformation.php +++ b/src/Model/TemplateInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateInformation Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateInformation implements ArrayAccess +class TemplateInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'templates' => '\DocuSign\eSign\Model\TemplateSummary[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'templates' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'templates' => 'templates' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'templates' => 'setTemplates' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'templates' => 'getTemplates' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets templates + * * @return \DocuSign\eSign\Model\TemplateSummary[] */ public function getTemplates() @@ -156,7 +216,9 @@ public function getTemplates() /** * Sets templates + * * @param \DocuSign\eSign\Model\TemplateSummary[] $templates + * * @return $this */ public function setTemplates($templates) @@ -167,7 +229,9 @@ public function setTemplates($templates) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateMatch.php b/src/Model/TemplateMatch.php index d7111075..7fb7689d 100644 --- a/src/Model/TemplateMatch.php +++ b/src/Model/TemplateMatch.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateMatch Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateMatch implements ArrayAccess +class TemplateMatch implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateMatch'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class TemplateMatch implements ArrayAccess 'match_percentage' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'document_end_page' => null, + 'document_start_page' => null, + 'match_percentage' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'match_percentage' => 'matchPercentage' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'match_percentage' => 'setMatchPercentage' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'match_percentage' => 'getMatchPercentage' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets document_end_page + * * @return string */ public function getDocumentEndPage() @@ -166,7 +228,9 @@ public function getDocumentEndPage() /** * Sets document_end_page + * * @param string $document_end_page + * * @return $this */ public function setDocumentEndPage($document_end_page) @@ -178,6 +242,7 @@ public function setDocumentEndPage($document_end_page) /** * Gets document_start_page + * * @return string */ public function getDocumentStartPage() @@ -187,7 +252,9 @@ public function getDocumentStartPage() /** * Sets document_start_page + * * @param string $document_start_page + * * @return $this */ public function setDocumentStartPage($document_start_page) @@ -199,6 +266,7 @@ public function setDocumentStartPage($document_start_page) /** * Gets match_percentage + * * @return string */ public function getMatchPercentage() @@ -208,7 +276,9 @@ public function getMatchPercentage() /** * Sets match_percentage + * * @param string $match_percentage + * * @return $this */ public function setMatchPercentage($match_percentage) @@ -219,7 +289,9 @@ public function setMatchPercentage($match_percentage) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateNotificationRequest.php b/src/Model/TemplateNotificationRequest.php index 783db9de..1e7e5470 100644 --- a/src/Model/TemplateNotificationRequest.php +++ b/src/Model/TemplateNotificationRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateNotificationRequest Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateNotificationRequest implements ArrayAccess +class TemplateNotificationRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateNotificationRequest'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class TemplateNotificationRequest implements ArrayAccess 'use_account_defaults' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'expirations' => null, + 'password' => null, + 'reminders' => null, + 'use_account_defaults' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'use_account_defaults' => 'useAccountDefaults' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'use_account_defaults' => 'setUseAccountDefaults' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'use_account_defaults' => 'getUseAccountDefaults' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets expirations + * * @return \DocuSign\eSign\Model\Expirations */ public function getExpirations() @@ -171,7 +234,9 @@ public function getExpirations() /** * Sets expirations - * @param \DocuSign\eSign\Model\Expirations $expirations + * + * @param \DocuSign\eSign\Model\Expirations $expirations expirations + * * @return $this */ public function setExpirations($expirations) @@ -183,6 +248,7 @@ public function setExpirations($expirations) /** * Gets password + * * @return string */ public function getPassword() @@ -192,7 +258,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -204,6 +272,7 @@ public function setPassword($password) /** * Gets reminders + * * @return \DocuSign\eSign\Model\Reminders */ public function getReminders() @@ -213,7 +282,9 @@ public function getReminders() /** * Sets reminders - * @param \DocuSign\eSign\Model\Reminders $reminders + * + * @param \DocuSign\eSign\Model\Reminders $reminders reminders + * * @return $this */ public function setReminders($reminders) @@ -225,6 +296,7 @@ public function setReminders($reminders) /** * Gets use_account_defaults + * * @return string */ public function getUseAccountDefaults() @@ -234,7 +306,9 @@ public function getUseAccountDefaults() /** * Sets use_account_defaults + * * @param string $use_account_defaults When set to **true**, the account default notification settings are used for the envelope. + * * @return $this */ public function setUseAccountDefaults($use_account_defaults) @@ -245,7 +319,9 @@ public function setUseAccountDefaults($use_account_defaults) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateRecipients.php b/src/Model/TemplateRecipients.php index 6dbee19b..65ffc9eb 100644 --- a/src/Model/TemplateRecipients.php +++ b/src/Model/TemplateRecipients.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateRecipients Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateRecipients implements ArrayAccess +class TemplateRecipients implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateRecipients'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -68,13 +71,50 @@ class TemplateRecipients implements ArrayAccess 'witnesses' => '\DocuSign\eSign\Model\Witness[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'agents' => null, + 'carbon_copies' => null, + 'certified_deliveries' => null, + 'current_routing_order' => null, + 'editors' => null, + 'error_details' => null, + 'in_person_signers' => null, + 'intermediaries' => null, + 'recipient_count' => null, + 'seals' => null, + 'signers' => null, + 'witnesses' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -92,9 +132,9 @@ public static function swaggerTypes() 'witnesses' => 'witnesses' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,9 +152,9 @@ public static function swaggerTypes() 'witnesses' => 'setWitnesses' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -132,34 +172,63 @@ public static function swaggerTypes() 'witnesses' => 'getWitnesses' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -178,30 +247,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets agents + * * @return \DocuSign\eSign\Model\Agent[] */ public function getAgents() @@ -211,7 +282,9 @@ public function getAgents() /** * Sets agents + * * @param \DocuSign\eSign\Model\Agent[] $agents A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. + * * @return $this */ public function setAgents($agents) @@ -223,6 +296,7 @@ public function setAgents($agents) /** * Gets carbon_copies + * * @return \DocuSign\eSign\Model\CarbonCopy[] */ public function getCarbonCopies() @@ -232,7 +306,9 @@ public function getCarbonCopies() /** * Sets carbon_copies + * * @param \DocuSign\eSign\Model\CarbonCopy[] $carbon_copies A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. + * * @return $this */ public function setCarbonCopies($carbon_copies) @@ -244,6 +320,7 @@ public function setCarbonCopies($carbon_copies) /** * Gets certified_deliveries + * * @return \DocuSign\eSign\Model\CertifiedDelivery[] */ public function getCertifiedDeliveries() @@ -253,7 +330,9 @@ public function getCertifiedDeliveries() /** * Sets certified_deliveries + * * @param \DocuSign\eSign\Model\CertifiedDelivery[] $certified_deliveries A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. + * * @return $this */ public function setCertifiedDeliveries($certified_deliveries) @@ -265,6 +344,7 @@ public function setCertifiedDeliveries($certified_deliveries) /** * Gets current_routing_order + * * @return string */ public function getCurrentRoutingOrder() @@ -274,7 +354,9 @@ public function getCurrentRoutingOrder() /** * Sets current_routing_order + * * @param string $current_routing_order + * * @return $this */ public function setCurrentRoutingOrder($current_routing_order) @@ -286,6 +368,7 @@ public function setCurrentRoutingOrder($current_routing_order) /** * Gets editors + * * @return \DocuSign\eSign\Model\Editor[] */ public function getEditors() @@ -295,7 +378,9 @@ public function getEditors() /** * Sets editors + * * @param \DocuSign\eSign\Model\Editor[] $editors + * * @return $this */ public function setEditors($editors) @@ -307,6 +392,7 @@ public function setEditors($editors) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -316,7 +402,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -328,6 +416,7 @@ public function setErrorDetails($error_details) /** * Gets in_person_signers + * * @return \DocuSign\eSign\Model\InPersonSigner[] */ public function getInPersonSigners() @@ -337,7 +426,9 @@ public function getInPersonSigners() /** * Sets in_person_signers + * * @param \DocuSign\eSign\Model\InPersonSigner[] $in_person_signers Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. + * * @return $this */ public function setInPersonSigners($in_person_signers) @@ -349,6 +440,7 @@ public function setInPersonSigners($in_person_signers) /** * Gets intermediaries + * * @return \DocuSign\eSign\Model\Intermediary[] */ public function getIntermediaries() @@ -358,7 +450,9 @@ public function getIntermediaries() /** * Sets intermediaries + * * @param \DocuSign\eSign\Model\Intermediary[] $intermediaries Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). + * * @return $this */ public function setIntermediaries($intermediaries) @@ -370,6 +464,7 @@ public function setIntermediaries($intermediaries) /** * Gets recipient_count + * * @return string */ public function getRecipientCount() @@ -379,7 +474,9 @@ public function getRecipientCount() /** * Sets recipient_count + * * @param string $recipient_count The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message. + * * @return $this */ public function setRecipientCount($recipient_count) @@ -391,6 +488,7 @@ public function setRecipientCount($recipient_count) /** * Gets seals + * * @return \DocuSign\eSign\Model\SealSign[] */ public function getSeals() @@ -400,7 +498,9 @@ public function getSeals() /** * Sets seals + * * @param \DocuSign\eSign\Model\SealSign[] $seals + * * @return $this */ public function setSeals($seals) @@ -412,6 +512,7 @@ public function setSeals($seals) /** * Gets signers + * * @return \DocuSign\eSign\Model\Signer[] */ public function getSigners() @@ -421,7 +522,9 @@ public function getSigners() /** * Sets signers + * * @param \DocuSign\eSign\Model\Signer[] $signers A complex type containing information about the Signer recipient. + * * @return $this */ public function setSigners($signers) @@ -433,6 +536,7 @@ public function setSigners($signers) /** * Gets witnesses + * * @return \DocuSign\eSign\Model\Witness[] */ public function getWitnesses() @@ -442,7 +546,9 @@ public function getWitnesses() /** * Sets witnesses + * * @param \DocuSign\eSign\Model\Witness[] $witnesses + * * @return $this */ public function setWitnesses($witnesses) @@ -453,7 +559,9 @@ public function setWitnesses($witnesses) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -463,7 +571,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -473,8 +583,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -488,7 +600,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -498,16 +612,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateRole.php b/src/Model/TemplateRole.php index be33c3eb..7c073b93 100644 --- a/src/Model/TemplateRole.php +++ b/src/Model/TemplateRole.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateRole Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateRole implements ArrayAccess +class TemplateRole implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateRole'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -69,13 +72,51 @@ class TemplateRole implements ArrayAccess 'tabs' => '\DocuSign\eSign\Model\Tabs' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'client_user_id' => null, + 'default_recipient' => null, + 'email' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'in_person_signer_name' => null, + 'name' => null, + 'recipient_signature_providers' => null, + 'role_name' => null, + 'routing_order' => null, + 'signing_group_id' => null, + 'tabs' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -94,9 +135,9 @@ public static function swaggerTypes() 'tabs' => 'tabs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -115,9 +156,9 @@ public static function swaggerTypes() 'tabs' => 'setTabs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -136,34 +177,63 @@ public static function swaggerTypes() 'tabs' => 'getTabs' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -183,30 +253,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -216,7 +288,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -228,6 +302,7 @@ public function setAccessCode($access_code) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -237,7 +312,9 @@ public function getClientUserId() /** * 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) @@ -249,6 +326,7 @@ public function setClientUserId($client_user_id) /** * Gets default_recipient + * * @return string */ public function getDefaultRecipient() @@ -258,7 +336,9 @@ public function getDefaultRecipient() /** * Sets default_recipient + * * @param string $default_recipient When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. + * * @return $this */ public function setDefaultRecipient($default_recipient) @@ -270,6 +350,7 @@ public function setDefaultRecipient($default_recipient) /** * Gets email + * * @return string */ public function getEmail() @@ -279,7 +360,9 @@ public function getEmail() /** * Sets email + * * @param string $email Specifies the email associated with a role name. + * * @return $this */ public function setEmail($email) @@ -291,6 +374,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -300,7 +384,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -312,6 +398,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -321,7 +408,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -333,6 +422,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets in_person_signer_name + * * @return string */ public function getInPersonSignerName() @@ -342,7 +432,9 @@ public function getInPersonSignerName() /** * Sets in_person_signer_name + * * @param string $in_person_signer_name Specifies the full legal name of the signer in person signer template roles. Maximum Length: 100 characters. + * * @return $this */ public function setInPersonSignerName($in_person_signer_name) @@ -354,6 +446,7 @@ public function setInPersonSignerName($in_person_signer_name) /** * Gets name + * * @return string */ public function getName() @@ -363,7 +456,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the recipient's name. + * * @return $this */ public function setName($name) @@ -375,6 +470,7 @@ public function setName($name) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -384,7 +480,9 @@ public function getRecipientSignatureProviders() /** * Sets recipient_signature_providers + * * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * * @return $this */ public function setRecipientSignatureProviders($recipient_signature_providers) @@ -396,6 +494,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -405,7 +504,9 @@ public function getRoleName() /** * 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) @@ -417,6 +518,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -426,7 +528,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -438,6 +542,7 @@ public function setRoutingOrder($routing_order) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -447,7 +552,9 @@ public function getSigningGroupId() /** * 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) @@ -459,6 +566,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -468,7 +576,9 @@ public function getTabs() /** * Sets tabs - * @param \DocuSign\eSign\Model\Tabs $tabs + * + * @param \DocuSign\eSign\Model\Tabs $tabs tabs + * * @return $this */ public function setTabs($tabs) @@ -479,7 +589,9 @@ public function setTabs($tabs) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -489,7 +601,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -499,8 +613,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -514,7 +630,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -524,16 +642,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateSharedItem.php b/src/Model/TemplateSharedItem.php index 51300c4d..8b08b96f 100644 --- a/src/Model/TemplateSharedItem.php +++ b/src/Model/TemplateSharedItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateSharedItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateSharedItem implements ArrayAccess +class TemplateSharedItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateSharedItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class TemplateSharedItem implements ArrayAccess 'template_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'owner' => null, + 'password' => null, + 'shared' => null, + 'shared_groups' => null, + 'shared_users' => null, + 'template_id' => null, + 'template_name' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'template_name' => 'templateName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'template_name' => 'setTemplateName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'template_name' => 'getTemplateName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -191,7 +258,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -203,6 +272,7 @@ public function setErrorDetails($error_details) /** * Gets owner + * * @return \DocuSign\eSign\Model\UserInfo */ public function getOwner() @@ -212,7 +282,9 @@ public function getOwner() /** * Sets owner - * @param \DocuSign\eSign\Model\UserInfo $owner + * + * @param \DocuSign\eSign\Model\UserInfo $owner owner + * * @return $this */ public function setOwner($owner) @@ -224,6 +296,7 @@ public function setOwner($owner) /** * Gets password + * * @return string */ public function getPassword() @@ -233,7 +306,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -245,6 +320,7 @@ public function setPassword($password) /** * Gets shared + * * @return string */ public function getShared() @@ -254,7 +330,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -266,6 +344,7 @@ public function setShared($shared) /** * Gets shared_groups + * * @return \DocuSign\eSign\Model\MemberGroupSharedItem[] */ public function getSharedGroups() @@ -275,7 +354,9 @@ public function getSharedGroups() /** * Sets shared_groups + * * @param \DocuSign\eSign\Model\MemberGroupSharedItem[] $shared_groups + * * @return $this */ public function setSharedGroups($shared_groups) @@ -287,6 +368,7 @@ public function setSharedGroups($shared_groups) /** * Gets shared_users + * * @return \DocuSign\eSign\Model\UserSharedItem[] */ public function getSharedUsers() @@ -296,7 +378,9 @@ public function getSharedUsers() /** * Sets shared_users + * * @param \DocuSign\eSign\Model\UserSharedItem[] $shared_users + * * @return $this */ public function setSharedUsers($shared_users) @@ -308,6 +392,7 @@ public function setSharedUsers($shared_users) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -317,7 +402,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -329,6 +416,7 @@ public function setTemplateId($template_id) /** * Gets template_name + * * @return string */ public function getTemplateName() @@ -338,7 +426,9 @@ public function getTemplateName() /** * Sets template_name + * * @param string $template_name + * * @return $this */ public function setTemplateName($template_name) @@ -349,7 +439,9 @@ public function setTemplateName($template_name) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateSummary.php b/src/Model/TemplateSummary.php index 9851e5a3..7e9235ec 100644 --- a/src/Model/TemplateSummary.php +++ b/src/Model/TemplateSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateSummary Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateSummary implements ArrayAccess +class TemplateSummary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateSummary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class TemplateSummary implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'applied' => null, + 'document_id' => null, + 'document_name' => null, + 'error_details' => null, + 'name' => null, + 'template_id' => null, + 'template_match' => null, + 'uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -84,9 +120,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'uri' => 'getUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -158,30 +223,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets applied + * * @return string */ public function getApplied() @@ -191,7 +258,9 @@ public function getApplied() /** * Sets applied + * * @param string $applied Reserved: TBD + * * @return $this */ public function setApplied($applied) @@ -203,6 +272,7 @@ public function setApplied($applied) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -212,7 +282,9 @@ public function getDocumentId() /** * 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) @@ -224,6 +296,7 @@ public function setDocumentId($document_id) /** * Gets document_name + * * @return string */ public function getDocumentName() @@ -233,7 +306,9 @@ public function getDocumentName() /** * Sets document_name + * * @param string $document_name + * * @return $this */ public function setDocumentName($document_name) @@ -245,6 +320,7 @@ public function setDocumentName($document_name) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -254,7 +330,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -266,6 +344,7 @@ public function setErrorDetails($error_details) /** * Gets name + * * @return string */ public function getName() @@ -275,7 +354,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -287,6 +368,7 @@ public function setName($name) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -296,7 +378,9 @@ public function getTemplateId() /** * Sets template_id + * * @param string $template_id The unique identifier of the template. If this is not provided, DocuSign will generate a value. + * * @return $this */ public function setTemplateId($template_id) @@ -308,6 +392,7 @@ public function setTemplateId($template_id) /** * Gets template_match + * * @return \DocuSign\eSign\Model\TemplateMatch */ public function getTemplateMatch() @@ -317,7 +402,9 @@ public function getTemplateMatch() /** * Sets template_match - * @param \DocuSign\eSign\Model\TemplateMatch $template_match + * + * @param \DocuSign\eSign\Model\TemplateMatch $template_match template_match + * * @return $this */ public function setTemplateMatch($template_match) @@ -329,6 +416,7 @@ public function setTemplateMatch($template_match) /** * Gets uri + * * @return string */ public function getUri() @@ -338,7 +426,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -349,7 +439,9 @@ public function setUri($uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -359,7 +451,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -369,8 +463,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -384,7 +480,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -394,16 +492,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateTabs.php b/src/Model/TemplateTabs.php index 592ae335..cb3fc380 100644 --- a/src/Model/TemplateTabs.php +++ b/src/Model/TemplateTabs.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateTabs Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateTabs implements ArrayAccess +class TemplateTabs implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateTabs'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -87,13 +90,69 @@ class TemplateTabs implements ArrayAccess 'zip_tabs' => '\DocuSign\eSign\Model\Zip[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'approve_tabs' => null, + 'checkbox_tabs' => null, + 'comment_thread_tabs' => null, + 'company_tabs' => null, + 'date_signed_tabs' => null, + 'date_tabs' => null, + 'decline_tabs' => null, + 'draw_tabs' => null, + 'email_address_tabs' => null, + 'email_tabs' => null, + 'envelope_id_tabs' => null, + 'first_name_tabs' => null, + 'formula_tabs' => null, + 'full_name_tabs' => null, + 'initial_here_tabs' => null, + 'last_name_tabs' => null, + 'list_tabs' => null, + 'notarize_tabs' => null, + 'note_tabs' => null, + 'number_tabs' => null, + 'poly_line_overlay_tabs' => null, + 'radio_group_tabs' => null, + 'signer_attachment_tabs' => null, + 'sign_here_tabs' => null, + 'smart_section_tabs' => null, + 'ssn_tabs' => null, + 'tab_groups' => null, + 'text_tabs' => null, + 'title_tabs' => null, + 'view_tabs' => null, + 'zip_tabs' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -130,9 +189,9 @@ public static function swaggerTypes() 'zip_tabs' => 'zipTabs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -169,9 +228,9 @@ public static function swaggerTypes() 'zip_tabs' => 'setZipTabs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -208,34 +267,63 @@ public static function swaggerTypes() 'zip_tabs' => 'getZipTabs' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -273,30 +361,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets approve_tabs + * * @return \DocuSign\eSign\Model\Approve[] */ public function getApproveTabs() @@ -306,7 +396,9 @@ public function getApproveTabs() /** * Sets approve_tabs + * * @param \DocuSign\eSign\Model\Approve[] $approve_tabs Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. + * * @return $this */ public function setApproveTabs($approve_tabs) @@ -318,6 +410,7 @@ public function setApproveTabs($approve_tabs) /** * Gets checkbox_tabs + * * @return \DocuSign\eSign\Model\Checkbox[] */ public function getCheckboxTabs() @@ -327,7 +420,9 @@ public function getCheckboxTabs() /** * Sets checkbox_tabs + * * @param \DocuSign\eSign\Model\Checkbox[] $checkbox_tabs Specifies a tag on the document in a location where the recipient can select an option. + * * @return $this */ public function setCheckboxTabs($checkbox_tabs) @@ -339,6 +434,7 @@ public function setCheckboxTabs($checkbox_tabs) /** * Gets comment_thread_tabs + * * @return \DocuSign\eSign\Model\CommentThread[] */ public function getCommentThreadTabs() @@ -348,7 +444,9 @@ public function getCommentThreadTabs() /** * Sets comment_thread_tabs + * * @param \DocuSign\eSign\Model\CommentThread[] $comment_thread_tabs + * * @return $this */ public function setCommentThreadTabs($comment_thread_tabs) @@ -360,6 +458,7 @@ public function setCommentThreadTabs($comment_thread_tabs) /** * Gets company_tabs + * * @return \DocuSign\eSign\Model\Company[] */ public function getCompanyTabs() @@ -369,7 +468,9 @@ public function getCompanyTabs() /** * Sets company_tabs + * * @param \DocuSign\eSign\Model\Company[] $company_tabs Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setCompanyTabs($company_tabs) @@ -381,6 +482,7 @@ public function setCompanyTabs($company_tabs) /** * Gets date_signed_tabs + * * @return \DocuSign\eSign\Model\DateSigned[] */ public function getDateSignedTabs() @@ -390,7 +492,9 @@ public function getDateSignedTabs() /** * Sets date_signed_tabs + * * @param \DocuSign\eSign\Model\DateSigned[] $date_signed_tabs Specifies a tab on the document where the date the document was signed will automatically appear. + * * @return $this */ public function setDateSignedTabs($date_signed_tabs) @@ -402,6 +506,7 @@ public function setDateSignedTabs($date_signed_tabs) /** * Gets date_tabs + * * @return \DocuSign\eSign\Model\\DateTime[] */ public function getDateTabs() @@ -411,7 +516,9 @@ public function getDateTabs() /** * Sets date_tabs + * * @param \DocuSign\eSign\Model\\DateTime[] $date_tabs Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. + * * @return $this */ public function setDateTabs($date_tabs) @@ -423,6 +530,7 @@ public function setDateTabs($date_tabs) /** * Gets decline_tabs + * * @return \DocuSign\eSign\Model\Decline[] */ public function getDeclineTabs() @@ -432,7 +540,9 @@ public function getDeclineTabs() /** * Sets decline_tabs + * * @param \DocuSign\eSign\Model\Decline[] $decline_tabs Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. + * * @return $this */ public function setDeclineTabs($decline_tabs) @@ -444,6 +554,7 @@ public function setDeclineTabs($decline_tabs) /** * Gets draw_tabs + * * @return \DocuSign\eSign\Model\Draw[] */ public function getDrawTabs() @@ -453,7 +564,9 @@ public function getDrawTabs() /** * Sets draw_tabs + * * @param \DocuSign\eSign\Model\Draw[] $draw_tabs + * * @return $this */ public function setDrawTabs($draw_tabs) @@ -465,6 +578,7 @@ public function setDrawTabs($draw_tabs) /** * Gets email_address_tabs + * * @return \DocuSign\eSign\Model\EmailAddress[] */ public function getEmailAddressTabs() @@ -474,7 +588,9 @@ 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. + * * @return $this */ public function setEmailAddressTabs($email_address_tabs) @@ -486,6 +602,7 @@ public function setEmailAddressTabs($email_address_tabs) /** * Gets email_tabs + * * @return \DocuSign\eSign\Model\Email[] */ public function getEmailTabs() @@ -495,7 +612,9 @@ public function getEmailTabs() /** * Sets email_tabs + * * @param \DocuSign\eSign\Model\Email[] $email_tabs Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setEmailTabs($email_tabs) @@ -507,6 +626,7 @@ public function setEmailTabs($email_tabs) /** * Gets envelope_id_tabs + * * @return \DocuSign\eSign\Model\EnvelopeId[] */ public function getEnvelopeIdTabs() @@ -516,7 +636,9 @@ public function getEnvelopeIdTabs() /** * Sets envelope_id_tabs + * * @param \DocuSign\eSign\Model\EnvelopeId[] $envelope_id_tabs Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. + * * @return $this */ public function setEnvelopeIdTabs($envelope_id_tabs) @@ -528,6 +650,7 @@ public function setEnvelopeIdTabs($envelope_id_tabs) /** * Gets first_name_tabs + * * @return \DocuSign\eSign\Model\FirstName[] */ public function getFirstNameTabs() @@ -537,7 +660,9 @@ public function getFirstNameTabs() /** * Sets first_name_tabs + * * @param \DocuSign\eSign\Model\FirstName[] $first_name_tabs Specifies tag on a document where you want the recipient's first 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 first section as the first name. + * * @return $this */ public function setFirstNameTabs($first_name_tabs) @@ -549,6 +674,7 @@ public function setFirstNameTabs($first_name_tabs) /** * Gets formula_tabs + * * @return \DocuSign\eSign\Model\FormulaTab[] */ public function getFormulaTabs() @@ -558,7 +684,9 @@ public function getFormulaTabs() /** * Sets formula_tabs + * * @param \DocuSign\eSign\Model\FormulaTab[] $formula_tabs Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the \"formula\" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas. + * * @return $this */ public function setFormulaTabs($formula_tabs) @@ -570,6 +698,7 @@ public function setFormulaTabs($formula_tabs) /** * Gets full_name_tabs + * * @return \DocuSign\eSign\Model\FullName[] */ public function getFullNameTabs() @@ -579,7 +708,9 @@ public function getFullNameTabs() /** * Sets full_name_tabs + * * @param \DocuSign\eSign\Model\FullName[] $full_name_tabs Specifies a tag on the document where you want the recipient's name to appear. + * * @return $this */ public function setFullNameTabs($full_name_tabs) @@ -591,6 +722,7 @@ public function setFullNameTabs($full_name_tabs) /** * Gets initial_here_tabs + * * @return \DocuSign\eSign\Model\InitialHere[] */ public function getInitialHereTabs() @@ -600,7 +732,9 @@ public function getInitialHereTabs() /** * Sets initial_here_tabs + * * @param \DocuSign\eSign\Model\InitialHere[] $initial_here_tabs Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional. + * * @return $this */ public function setInitialHereTabs($initial_here_tabs) @@ -612,6 +746,7 @@ public function setInitialHereTabs($initial_here_tabs) /** * Gets last_name_tabs + * * @return \DocuSign\eSign\Model\LastName[] */ public function getLastNameTabs() @@ -621,7 +756,9 @@ 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. + * * @return $this */ public function setLastNameTabs($last_name_tabs) @@ -633,6 +770,7 @@ public function setLastNameTabs($last_name_tabs) /** * Gets list_tabs + * * @return \DocuSign\eSign\Model\array[] */ public function getListTabs() @@ -642,7 +780,9 @@ public function getListTabs() /** * Sets list_tabs + * * @param \DocuSign\eSign\Model\array[] $list_tabs Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. + * * @return $this */ public function setListTabs($list_tabs) @@ -654,6 +794,7 @@ public function setListTabs($list_tabs) /** * Gets notarize_tabs + * * @return \DocuSign\eSign\Model\Notarize[] */ public function getNotarizeTabs() @@ -663,7 +804,9 @@ public function getNotarizeTabs() /** * Sets notarize_tabs + * * @param \DocuSign\eSign\Model\Notarize[] $notarize_tabs + * * @return $this */ public function setNotarizeTabs($notarize_tabs) @@ -675,6 +818,7 @@ public function setNotarizeTabs($notarize_tabs) /** * Gets note_tabs + * * @return \DocuSign\eSign\Model\Note[] */ public function getNoteTabs() @@ -684,7 +828,9 @@ public function getNoteTabs() /** * Sets note_tabs + * * @param \DocuSign\eSign\Model\Note[] $note_tabs Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient. + * * @return $this */ public function setNoteTabs($note_tabs) @@ -696,6 +842,7 @@ public function setNoteTabs($note_tabs) /** * Gets number_tabs + * * @return \DocuSign\eSign\Model\Number[] */ public function getNumberTabs() @@ -705,7 +852,9 @@ public function getNumberTabs() /** * Sets number_tabs + * * @param \DocuSign\eSign\Model\Number[] $number_tabs Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setNumberTabs($number_tabs) @@ -717,6 +866,7 @@ public function setNumberTabs($number_tabs) /** * Gets poly_line_overlay_tabs + * * @return \DocuSign\eSign\Model\PolyLineOverlay[] */ public function getPolyLineOverlayTabs() @@ -726,7 +876,9 @@ public function getPolyLineOverlayTabs() /** * Sets poly_line_overlay_tabs + * * @param \DocuSign\eSign\Model\PolyLineOverlay[] $poly_line_overlay_tabs + * * @return $this */ public function setPolyLineOverlayTabs($poly_line_overlay_tabs) @@ -738,6 +890,7 @@ public function setPolyLineOverlayTabs($poly_line_overlay_tabs) /** * Gets radio_group_tabs + * * @return \DocuSign\eSign\Model\RadioGroup[] */ public function getRadioGroupTabs() @@ -747,7 +900,9 @@ public function getRadioGroupTabs() /** * Sets radio_group_tabs + * * @param \DocuSign\eSign\Model\RadioGroup[] $radio_group_tabs Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. + * * @return $this */ public function setRadioGroupTabs($radio_group_tabs) @@ -759,6 +914,7 @@ public function setRadioGroupTabs($radio_group_tabs) /** * Gets signer_attachment_tabs + * * @return \DocuSign\eSign\Model\SignerAttachment[] */ public function getSignerAttachmentTabs() @@ -768,7 +924,9 @@ public function getSignerAttachmentTabs() /** * Sets signer_attachment_tabs + * * @param \DocuSign\eSign\Model\SignerAttachment[] $signer_attachment_tabs Specifies a tag on the document when you want the recipient to add supporting documents to an envelope. + * * @return $this */ public function setSignerAttachmentTabs($signer_attachment_tabs) @@ -780,6 +938,7 @@ public function setSignerAttachmentTabs($signer_attachment_tabs) /** * Gets sign_here_tabs + * * @return \DocuSign\eSign\Model\SignHere[] */ public function getSignHereTabs() @@ -789,7 +948,9 @@ public function getSignHereTabs() /** * Sets sign_here_tabs + * * @param \DocuSign\eSign\Model\SignHere[] $sign_here_tabs A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The \"optional\" parameter sets if the signature is required or optional. + * * @return $this */ public function setSignHereTabs($sign_here_tabs) @@ -801,6 +962,7 @@ public function setSignHereTabs($sign_here_tabs) /** * Gets smart_section_tabs + * * @return \DocuSign\eSign\Model\SmartSection[] */ public function getSmartSectionTabs() @@ -810,7 +972,9 @@ public function getSmartSectionTabs() /** * Sets smart_section_tabs + * * @param \DocuSign\eSign\Model\SmartSection[] $smart_section_tabs + * * @return $this */ public function setSmartSectionTabs($smart_section_tabs) @@ -822,6 +986,7 @@ public function setSmartSectionTabs($smart_section_tabs) /** * Gets ssn_tabs + * * @return \DocuSign\eSign\Model\Ssn[] */ public function getSsnTabs() @@ -831,7 +996,9 @@ public function getSsnTabs() /** * Sets ssn_tabs + * * @param \DocuSign\eSign\Model\Ssn[] $ssn_tabs Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setSsnTabs($ssn_tabs) @@ -843,6 +1010,7 @@ public function setSsnTabs($ssn_tabs) /** * Gets tab_groups + * * @return \DocuSign\eSign\Model\TabGroup[] */ public function getTabGroups() @@ -852,7 +1020,9 @@ public function getTabGroups() /** * Sets tab_groups + * * @param \DocuSign\eSign\Model\TabGroup[] $tab_groups + * * @return $this */ public function setTabGroups($tab_groups) @@ -864,6 +1034,7 @@ public function setTabGroups($tab_groups) /** * Gets text_tabs + * * @return \DocuSign\eSign\Model\Text[] */ public function getTextTabs() @@ -873,7 +1044,9 @@ public function getTextTabs() /** * Sets text_tabs + * * @param \DocuSign\eSign\Model\Text[] $text_tabs Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setTextTabs($text_tabs) @@ -885,6 +1058,7 @@ public function setTextTabs($text_tabs) /** * Gets title_tabs + * * @return \DocuSign\eSign\Model\Title[] */ public function getTitleTabs() @@ -894,7 +1068,9 @@ public function getTitleTabs() /** * Sets title_tabs + * * @param \DocuSign\eSign\Model\Title[] $title_tabs Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setTitleTabs($title_tabs) @@ -906,6 +1082,7 @@ public function setTitleTabs($title_tabs) /** * Gets view_tabs + * * @return \DocuSign\eSign\Model\View[] */ public function getViewTabs() @@ -915,7 +1092,9 @@ public function getViewTabs() /** * Sets view_tabs + * * @param \DocuSign\eSign\Model\View[] $view_tabs + * * @return $this */ public function setViewTabs($view_tabs) @@ -927,6 +1106,7 @@ public function setViewTabs($view_tabs) /** * Gets zip_tabs + * * @return \DocuSign\eSign\Model\Zip[] */ public function getZipTabs() @@ -936,7 +1116,9 @@ public function getZipTabs() /** * Sets zip_tabs + * * @param \DocuSign\eSign\Model\Zip[] $zip_tabs Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. + * * @return $this */ public function setZipTabs($zip_tabs) @@ -947,7 +1129,9 @@ public function setZipTabs($zip_tabs) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -957,7 +1141,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -967,8 +1153,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -982,7 +1170,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -992,16 +1182,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TemplateUpdateSummary.php b/src/Model/TemplateUpdateSummary.php index 455e1b04..b94e3d41 100644 --- a/src/Model/TemplateUpdateSummary.php +++ b/src/Model/TemplateUpdateSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TemplateUpdateSummary Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TemplateUpdateSummary implements ArrayAccess +class TemplateUpdateSummary implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'templateUpdateSummary'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,47 @@ class TemplateUpdateSummary implements ArrayAccess 'text_custom_field_update_results' => '\DocuSign\eSign\Model\TextCustomField[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'bulk_envelope_status' => null, + 'envelope_id' => null, + 'error_details' => null, + 'list_custom_field_update_results' => null, + 'lock_information' => null, + 'purge_state' => null, + 'recipient_update_results' => null, + 'tab_update_results' => null, + 'text_custom_field_update_results' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -86,9 +123,9 @@ public static function swaggerTypes() 'text_custom_field_update_results' => 'textCustomFieldUpdateResults' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -103,9 +140,9 @@ public static function swaggerTypes() 'text_custom_field_update_results' => 'setTextCustomFieldUpdateResults' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -120,34 +157,63 @@ public static function swaggerTypes() 'text_custom_field_update_results' => 'getTextCustomFieldUpdateResults' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -163,30 +229,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets bulk_envelope_status + * * @return \DocuSign\eSign\Model\BulkEnvelopeStatus */ public function getBulkEnvelopeStatus() @@ -196,7 +264,9 @@ public function getBulkEnvelopeStatus() /** * Sets bulk_envelope_status - * @param \DocuSign\eSign\Model\BulkEnvelopeStatus $bulk_envelope_status + * + * @param \DocuSign\eSign\Model\BulkEnvelopeStatus $bulk_envelope_status bulk_envelope_status + * * @return $this */ public function setBulkEnvelopeStatus($bulk_envelope_status) @@ -208,6 +278,7 @@ public function setBulkEnvelopeStatus($bulk_envelope_status) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -217,7 +288,9 @@ public function getEnvelopeId() /** * 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) @@ -229,6 +302,7 @@ public function setEnvelopeId($envelope_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -238,7 +312,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -250,6 +326,7 @@ public function setErrorDetails($error_details) /** * Gets list_custom_field_update_results + * * @return \DocuSign\eSign\Model\ListCustomField[] */ public function getListCustomFieldUpdateResults() @@ -259,7 +336,9 @@ public function getListCustomFieldUpdateResults() /** * Sets list_custom_field_update_results + * * @param \DocuSign\eSign\Model\ListCustomField[] $list_custom_field_update_results + * * @return $this */ public function setListCustomFieldUpdateResults($list_custom_field_update_results) @@ -271,6 +350,7 @@ public function setListCustomFieldUpdateResults($list_custom_field_update_result /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -280,7 +360,9 @@ public function getLockInformation() /** * Sets lock_information - * @param \DocuSign\eSign\Model\LockInformation $lock_information + * + * @param \DocuSign\eSign\Model\LockInformation $lock_information lock_information + * * @return $this */ public function setLockInformation($lock_information) @@ -292,6 +374,7 @@ public function setLockInformation($lock_information) /** * Gets purge_state + * * @return string */ public function getPurgeState() @@ -301,7 +384,9 @@ public function getPurgeState() /** * Sets purge_state + * * @param string $purge_state + * * @return $this */ public function setPurgeState($purge_state) @@ -313,6 +398,7 @@ public function setPurgeState($purge_state) /** * Gets recipient_update_results + * * @return \DocuSign\eSign\Model\RecipientUpdateResponse[] */ public function getRecipientUpdateResults() @@ -322,7 +408,9 @@ public function getRecipientUpdateResults() /** * Sets recipient_update_results + * * @param \DocuSign\eSign\Model\RecipientUpdateResponse[] $recipient_update_results + * * @return $this */ public function setRecipientUpdateResults($recipient_update_results) @@ -334,6 +422,7 @@ public function setRecipientUpdateResults($recipient_update_results) /** * Gets tab_update_results + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabUpdateResults() @@ -343,7 +432,9 @@ public function getTabUpdateResults() /** * Sets tab_update_results - * @param \DocuSign\eSign\Model\Tabs $tab_update_results + * + * @param \DocuSign\eSign\Model\Tabs $tab_update_results tab_update_results + * * @return $this */ public function setTabUpdateResults($tab_update_results) @@ -355,6 +446,7 @@ public function setTabUpdateResults($tab_update_results) /** * Gets text_custom_field_update_results + * * @return \DocuSign\eSign\Model\TextCustomField[] */ public function getTextCustomFieldUpdateResults() @@ -364,7 +456,9 @@ public function getTextCustomFieldUpdateResults() /** * Sets text_custom_field_update_results + * * @param \DocuSign\eSign\Model\TextCustomField[] $text_custom_field_update_results + * * @return $this */ public function setTextCustomFieldUpdateResults($text_custom_field_update_results) @@ -375,7 +469,9 @@ public function setTextCustomFieldUpdateResults($text_custom_field_update_result } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -385,7 +481,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -395,8 +493,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -410,7 +510,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -420,16 +522,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Text.php b/src/Model/Text.php index 48a6e41f..113c3207 100644 --- a/src/Model/Text.php +++ b/src/Model/Text.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Text Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Text implements ArrayAccess +class Text implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'text'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -171,13 +174,153 @@ class Text implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conceal_value_on_document' => null, + 'conceal_value_on_document_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'disable_auto_size' => null, + 'disable_auto_size_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'formula' => null, + 'formula_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'is_payment_amount' => null, + 'is_payment_amount_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'max_length' => null, + 'max_length_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'original_value' => null, + 'original_value_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'require_all' => null, + 'require_all_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'sender_required' => null, + 'sender_required_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'validation_message' => null, + 'validation_message_metadata' => null, + 'validation_pattern' => null, + 'validation_pattern_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -298,9 +441,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -421,9 +564,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -544,34 +687,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -693,30 +865,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -726,7 +900,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -738,6 +914,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -747,7 +924,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -759,6 +938,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -768,7 +948,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -780,6 +962,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -789,7 +972,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -801,6 +986,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -810,7 +996,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -822,6 +1010,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -831,7 +1020,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -843,6 +1034,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -852,7 +1044,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -864,6 +1058,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -873,7 +1068,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -885,6 +1082,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -894,7 +1092,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -906,6 +1106,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -915,7 +1116,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -927,6 +1130,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -936,7 +1140,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -948,6 +1154,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -957,7 +1164,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -969,6 +1178,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -978,7 +1188,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -990,6 +1202,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -999,7 +1212,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -1011,6 +1226,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -1020,7 +1236,9 @@ public function getAnchorUnits() /** * 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) @@ -1032,6 +1250,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -1041,7 +1260,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -1053,6 +1274,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -1062,7 +1284,9 @@ public function getAnchorXOffset() /** * 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) @@ -1074,6 +1298,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1083,7 +1308,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1095,6 +1322,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1104,7 +1332,9 @@ public function getAnchorYOffset() /** * 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) @@ -1116,6 +1346,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1125,7 +1356,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1137,6 +1370,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1146,7 +1380,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1158,6 +1394,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1167,7 +1404,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1179,6 +1418,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -1188,7 +1428,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -1200,6 +1442,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conceal_value_on_document_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConcealValueOnDocumentMetadata() @@ -1209,7 +1452,9 @@ public function getConcealValueOnDocumentMetadata() /** * Sets conceal_value_on_document_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata conceal_value_on_document_metadata + * * @return $this */ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_metadata) @@ -1221,6 +1466,7 @@ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_met /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1230,7 +1476,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1242,6 +1490,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1251,7 +1500,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1263,6 +1514,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1272,7 +1524,9 @@ public function getConditionalParentValue() /** * 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) @@ -1284,6 +1538,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1293,7 +1548,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1305,6 +1562,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1314,7 +1572,9 @@ public function getCustomTabId() /** * 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) @@ -1326,6 +1586,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1335,7 +1596,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1347,6 +1610,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -1356,7 +1620,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -1368,6 +1634,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets disable_auto_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisableAutoSizeMetadata() @@ -1377,7 +1644,9 @@ public function getDisableAutoSizeMetadata() /** * Sets disable_auto_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata disable_auto_size_metadata + * * @return $this */ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) @@ -1389,6 +1658,7 @@ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1398,7 +1668,9 @@ public function getDocumentId() /** * 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) @@ -1410,6 +1682,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1419,7 +1692,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1431,6 +1706,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1440,7 +1716,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1452,6 +1730,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1461,7 +1740,9 @@ public function getFont() /** * 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) @@ -1473,6 +1754,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1482,7 +1764,9 @@ public function getFontColor() /** * 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) @@ -1494,6 +1778,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1503,7 +1788,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1515,6 +1802,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1524,7 +1812,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1536,6 +1826,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1545,7 +1836,9 @@ public function getFontSize() /** * 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) @@ -1557,6 +1850,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1566,7 +1860,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1578,6 +1874,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1587,7 +1884,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1599,6 +1898,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1608,7 +1908,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1620,6 +1922,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1629,7 +1932,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1641,6 +1946,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1650,7 +1956,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1662,6 +1970,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1671,7 +1980,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1683,6 +1994,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1692,7 +2004,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1704,6 +2018,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets formula + * * @return string */ public function getFormula() @@ -1713,7 +2028,9 @@ public function getFormula() /** * Sets formula + * * @param string $formula The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] + * * @return $this */ public function setFormula($formula) @@ -1725,6 +2042,7 @@ public function setFormula($formula) /** * Gets formula_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormulaMetadata() @@ -1734,7 +2052,9 @@ public function getFormulaMetadata() /** * Sets formula_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $formula_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $formula_metadata formula_metadata + * * @return $this */ public function setFormulaMetadata($formula_metadata) @@ -1746,6 +2066,7 @@ public function setFormulaMetadata($formula_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1755,7 +2076,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1767,6 +2090,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1776,7 +2100,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1788,6 +2114,7 @@ public function setHeightMetadata($height_metadata) /** * Gets is_payment_amount + * * @return string */ public function getIsPaymentAmount() @@ -1797,7 +2124,9 @@ public function getIsPaymentAmount() /** * Sets is_payment_amount + * * @param string $is_payment_amount When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. + * * @return $this */ public function setIsPaymentAmount($is_payment_amount) @@ -1809,6 +2138,7 @@ public function setIsPaymentAmount($is_payment_amount) /** * Gets is_payment_amount_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIsPaymentAmountMetadata() @@ -1818,7 +2148,9 @@ public function getIsPaymentAmountMetadata() /** * Sets is_payment_amount_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $is_payment_amount_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $is_payment_amount_metadata is_payment_amount_metadata + * * @return $this */ public function setIsPaymentAmountMetadata($is_payment_amount_metadata) @@ -1830,6 +2162,7 @@ public function setIsPaymentAmountMetadata($is_payment_amount_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1839,7 +2172,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1851,6 +2186,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1860,7 +2196,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1872,6 +2210,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1881,7 +2220,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1893,6 +2234,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1902,7 +2244,9 @@ public function getLocked() /** * 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) @@ -1914,6 +2258,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1923,7 +2268,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1935,6 +2282,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets max_length + * * @return string */ public function getMaxLength() @@ -1944,7 +2292,9 @@ public function getMaxLength() /** * Sets max_length + * * @param string $max_length An optional value that describes the maximum length of the property when the property is a string. + * * @return $this */ public function setMaxLength($max_length) @@ -1956,6 +2306,7 @@ public function setMaxLength($max_length) /** * Gets max_length_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaxLengthMetadata() @@ -1965,7 +2316,9 @@ public function getMaxLengthMetadata() /** * Sets max_length_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata max_length_metadata + * * @return $this */ public function setMaxLengthMetadata($max_length_metadata) @@ -1977,6 +2330,7 @@ public function setMaxLengthMetadata($max_length_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1986,7 +2340,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1998,6 +2354,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -2007,7 +2364,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -2019,6 +2378,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -2028,7 +2388,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -2040,6 +2402,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -2049,7 +2412,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -2061,6 +2426,7 @@ public function setNameMetadata($name_metadata) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -2070,7 +2436,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -2082,6 +2450,7 @@ public function setOriginalValue($original_value) /** * Gets original_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOriginalValueMetadata() @@ -2091,7 +2460,9 @@ public function getOriginalValueMetadata() /** * Sets original_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata original_value_metadata + * * @return $this */ public function setOriginalValueMetadata($original_value_metadata) @@ -2103,6 +2474,7 @@ public function setOriginalValueMetadata($original_value_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -2112,7 +2484,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -2124,6 +2498,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -2133,7 +2508,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -2145,6 +2522,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -2154,7 +2532,9 @@ public function getRecipientId() /** * 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) @@ -2166,6 +2546,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -2175,7 +2556,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -2187,6 +2570,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -2196,7 +2580,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -2208,6 +2594,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -2217,7 +2604,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -2229,6 +2618,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -2238,7 +2628,9 @@ public function getRequireAll() /** * 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) @@ -2250,6 +2642,7 @@ public function setRequireAll($require_all) /** * Gets require_all_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireAllMetadata() @@ -2259,7 +2652,9 @@ public function getRequireAllMetadata() /** * Sets require_all_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata require_all_metadata + * * @return $this */ public function setRequireAllMetadata($require_all_metadata) @@ -2271,6 +2666,7 @@ public function setRequireAllMetadata($require_all_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -2280,7 +2676,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -2292,6 +2690,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -2301,7 +2700,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2313,6 +2714,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -2322,7 +2724,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -2334,6 +2738,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -2343,7 +2748,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -2355,6 +2762,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -2364,7 +2772,9 @@ public function getSenderRequired() /** * 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. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + * * @return $this */ public function setSenderRequired($sender_required) @@ -2376,6 +2786,7 @@ public function setSenderRequired($sender_required) /** * Gets sender_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderRequiredMetadata() @@ -2385,7 +2796,9 @@ public function getSenderRequiredMetadata() /** * Sets sender_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata sender_required_metadata + * * @return $this */ public function setSenderRequiredMetadata($sender_required_metadata) @@ -2397,6 +2810,7 @@ public function setSenderRequiredMetadata($sender_required_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -2406,7 +2820,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -2418,6 +2834,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -2427,7 +2844,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -2439,6 +2858,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2448,7 +2868,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2460,6 +2882,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2469,7 +2892,9 @@ public function getStatus() /** * 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) @@ -2481,6 +2906,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2490,7 +2916,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2502,6 +2930,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2511,7 +2940,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2523,6 +2954,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2532,7 +2964,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2544,6 +2978,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2553,7 +2988,9 @@ public function getTabId() /** * 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) @@ -2565,6 +3002,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2574,7 +3012,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2586,6 +3026,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2595,7 +3036,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2607,6 +3050,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2616,7 +3060,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2628,6 +3074,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2637,7 +3084,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2649,6 +3098,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2658,7 +3108,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2670,6 +3122,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2679,7 +3132,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2691,6 +3146,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2700,7 +3156,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2712,6 +3170,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2721,7 +3180,9 @@ public function getTemplateLocked() /** * 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) @@ -2733,6 +3194,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2742,7 +3204,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2754,6 +3218,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2763,7 +3228,9 @@ public function getTemplateRequired() /** * 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) @@ -2775,6 +3242,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2784,7 +3252,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2796,6 +3266,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2805,7 +3276,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2817,6 +3290,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2826,7 +3300,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2838,6 +3314,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2847,7 +3324,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2859,6 +3338,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2868,7 +3348,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2880,6 +3362,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -2889,7 +3372,9 @@ public function getValidationMessage() /** * Sets validation_message + * * @param string $validation_message The message displayed if the custom tab fails input validation (either custom of embedded). + * * @return $this */ public function setValidationMessage($validation_message) @@ -2901,6 +3386,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_message_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationMessageMetadata() @@ -2910,7 +3396,9 @@ public function getValidationMessageMetadata() /** * Sets validation_message_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata validation_message_metadata + * * @return $this */ public function setValidationMessageMetadata($validation_message_metadata) @@ -2922,6 +3410,7 @@ public function setValidationMessageMetadata($validation_message_metadata) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -2931,7 +3420,9 @@ public function getValidationPattern() /** * Sets validation_pattern + * * @param string $validation_pattern A regular expression used to validate input for the tab. + * * @return $this */ public function setValidationPattern($validation_pattern) @@ -2943,6 +3434,7 @@ public function setValidationPattern($validation_pattern) /** * Gets validation_pattern_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationPatternMetadata() @@ -2952,7 +3444,9 @@ public function getValidationPatternMetadata() /** * Sets validation_pattern_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata validation_pattern_metadata + * * @return $this */ public function setValidationPatternMetadata($validation_pattern_metadata) @@ -2964,6 +3458,7 @@ public function setValidationPatternMetadata($validation_pattern_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2973,7 +3468,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2985,6 +3482,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2994,7 +3492,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -3006,6 +3506,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -3015,7 +3516,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -3027,6 +3530,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -3036,7 +3540,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -3048,6 +3554,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -3057,7 +3564,9 @@ public function getXPosition() /** * 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) @@ -3069,6 +3578,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -3078,7 +3588,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -3090,6 +3602,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -3099,7 +3612,9 @@ public function getYPosition() /** * 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) @@ -3111,6 +3626,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -3120,7 +3636,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -3131,7 +3649,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -3141,7 +3661,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -3151,8 +3673,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -3166,7 +3690,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -3176,16 +3702,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/TextCustomField.php b/src/Model/TextCustomField.php index d405d876..4df3bcbc 100644 --- a/src/Model/TextCustomField.php +++ b/src/Model/TextCustomField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * TextCustomField Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class TextCustomField implements ArrayAccess +class TextCustomField implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'textCustomField'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class TextCustomField implements ArrayAccess 'value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'configuration_type' => null, + 'error_details' => null, + 'field_id' => null, + 'name' => null, + 'required' => null, + 'show' => null, + 'value' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'value' => 'value' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'value' => 'setValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'value' => 'getValue' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets configuration_type + * * @return string */ public function getConfigurationType() @@ -186,7 +252,9 @@ public function getConfigurationType() /** * Sets configuration_type + * * @param string $configuration_type If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. + * * @return $this */ public function setConfigurationType($configuration_type) @@ -198,6 +266,7 @@ public function setConfigurationType($configuration_type) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -207,7 +276,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -219,6 +290,7 @@ public function setErrorDetails($error_details) /** * Gets field_id + * * @return string */ public function getFieldId() @@ -228,7 +300,9 @@ public function getFieldId() /** * Sets field_id + * * @param string $field_id An ID used to specify a custom field. + * * @return $this */ public function setFieldId($field_id) @@ -240,6 +314,7 @@ public function setFieldId($field_id) /** * Gets name + * * @return string */ public function getName() @@ -249,7 +324,9 @@ public function getName() /** * Sets name + * * @param string $name The name of the custom field. + * * @return $this */ public function setName($name) @@ -261,6 +338,7 @@ public function setName($name) /** * Gets required + * * @return string */ public function getRequired() @@ -270,7 +348,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -282,6 +362,7 @@ public function setRequired($required) /** * Gets show + * * @return string */ public function getShow() @@ -291,7 +372,9 @@ public function getShow() /** * Sets show + * * @param string $show A boolean indicating if the value should be displayed. + * * @return $this */ public function setShow($show) @@ -303,6 +386,7 @@ public function setShow($show) /** * Gets value + * * @return string */ public function getValue() @@ -312,7 +396,9 @@ public function getValue() /** * Sets value + * * @param string $value The value of the custom field. + * * @return $this */ public function setValue($value) @@ -323,7 +409,9 @@ public function setValue($value) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Title.php b/src/Model/Title.php index 819655aa..77dda23c 100644 --- a/src/Model/Title.php +++ b/src/Model/Title.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Title Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Title implements ArrayAccess +class Title implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'title'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -155,13 +158,137 @@ class Title implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conceal_value_on_document' => null, + 'conceal_value_on_document_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'disable_auto_size' => null, + 'disable_auto_size_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'max_length' => null, + 'max_length_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'original_value' => null, + 'original_value_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -266,9 +393,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -373,9 +500,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -480,34 +607,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -613,30 +769,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -646,7 +804,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -658,6 +818,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -667,7 +828,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -679,6 +842,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -688,7 +852,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -700,6 +866,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -709,7 +876,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -721,6 +890,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -730,7 +900,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -742,6 +914,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -751,7 +924,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -763,6 +938,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -772,7 +948,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -784,6 +962,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -793,7 +972,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -805,6 +986,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -814,7 +996,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -826,6 +1010,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -835,7 +1020,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -847,6 +1034,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -856,7 +1044,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -868,6 +1058,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -877,7 +1068,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -889,6 +1082,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -898,7 +1092,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -910,6 +1106,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -919,7 +1116,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -931,6 +1130,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -940,7 +1140,9 @@ public function getAnchorUnits() /** * 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) @@ -952,6 +1154,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -961,7 +1164,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -973,6 +1178,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -982,7 +1188,9 @@ public function getAnchorXOffset() /** * 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) @@ -994,6 +1202,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1003,7 +1212,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1015,6 +1226,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1024,7 +1236,9 @@ public function getAnchorYOffset() /** * 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) @@ -1036,6 +1250,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1045,7 +1260,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1057,6 +1274,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1066,7 +1284,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1078,6 +1298,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1087,7 +1308,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1099,6 +1322,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -1108,7 +1332,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -1120,6 +1346,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conceal_value_on_document_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConcealValueOnDocumentMetadata() @@ -1129,7 +1356,9 @@ public function getConcealValueOnDocumentMetadata() /** * Sets conceal_value_on_document_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata conceal_value_on_document_metadata + * * @return $this */ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_metadata) @@ -1141,6 +1370,7 @@ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_met /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1150,7 +1380,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1162,6 +1394,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1171,7 +1404,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1183,6 +1418,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1192,7 +1428,9 @@ public function getConditionalParentValue() /** * 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) @@ -1204,6 +1442,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1213,7 +1452,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1225,6 +1466,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1234,7 +1476,9 @@ public function getCustomTabId() /** * 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) @@ -1246,6 +1490,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1255,7 +1500,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1267,6 +1514,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -1276,7 +1524,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -1288,6 +1538,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets disable_auto_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisableAutoSizeMetadata() @@ -1297,7 +1548,9 @@ public function getDisableAutoSizeMetadata() /** * Sets disable_auto_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata disable_auto_size_metadata + * * @return $this */ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) @@ -1309,6 +1562,7 @@ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1318,7 +1572,9 @@ public function getDocumentId() /** * 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) @@ -1330,6 +1586,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1339,7 +1596,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1351,6 +1610,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1360,7 +1620,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1372,6 +1634,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1381,7 +1644,9 @@ public function getFont() /** * 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) @@ -1393,6 +1658,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1402,7 +1668,9 @@ public function getFontColor() /** * 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) @@ -1414,6 +1682,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1423,7 +1692,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1435,6 +1706,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1444,7 +1716,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1456,6 +1730,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1465,7 +1740,9 @@ public function getFontSize() /** * 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) @@ -1477,6 +1754,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1486,7 +1764,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1498,6 +1778,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1507,7 +1788,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1519,6 +1802,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1528,7 +1812,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1540,6 +1826,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1549,7 +1836,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1561,6 +1850,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1570,7 +1860,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1582,6 +1874,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1591,7 +1884,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1603,6 +1898,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1612,7 +1908,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1624,6 +1922,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1633,7 +1932,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1645,6 +1946,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1654,7 +1956,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1666,6 +1970,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1675,7 +1980,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1687,6 +1994,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1696,7 +2004,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1708,6 +2018,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1717,7 +2028,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1729,6 +2042,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1738,7 +2052,9 @@ public function getLocked() /** * 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) @@ -1750,6 +2066,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1759,7 +2076,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1771,6 +2090,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets max_length + * * @return string */ public function getMaxLength() @@ -1780,7 +2100,9 @@ public function getMaxLength() /** * Sets max_length + * * @param string $max_length An optional value that describes the maximum length of the property when the property is a string. + * * @return $this */ public function setMaxLength($max_length) @@ -1792,6 +2114,7 @@ public function setMaxLength($max_length) /** * Gets max_length_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaxLengthMetadata() @@ -1801,7 +2124,9 @@ public function getMaxLengthMetadata() /** * Sets max_length_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata max_length_metadata + * * @return $this */ public function setMaxLengthMetadata($max_length_metadata) @@ -1813,6 +2138,7 @@ public function setMaxLengthMetadata($max_length_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1822,7 +2148,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1834,6 +2162,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1843,7 +2172,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1855,6 +2186,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1864,7 +2196,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1876,6 +2210,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1885,7 +2220,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1897,6 +2234,7 @@ public function setNameMetadata($name_metadata) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -1906,7 +2244,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -1918,6 +2258,7 @@ public function setOriginalValue($original_value) /** * Gets original_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOriginalValueMetadata() @@ -1927,7 +2268,9 @@ public function getOriginalValueMetadata() /** * Sets original_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata original_value_metadata + * * @return $this */ public function setOriginalValueMetadata($original_value_metadata) @@ -1939,6 +2282,7 @@ public function setOriginalValueMetadata($original_value_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1948,7 +2292,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1960,6 +2306,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1969,7 +2316,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1981,6 +2330,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1990,7 +2340,9 @@ public function getRecipientId() /** * 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) @@ -2002,6 +2354,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -2011,7 +2364,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -2023,6 +2378,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -2032,7 +2388,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -2044,6 +2402,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -2053,7 +2412,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -2065,6 +2426,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -2074,7 +2436,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -2086,6 +2450,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -2095,7 +2460,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2107,6 +2474,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2116,7 +2484,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2128,6 +2498,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2137,7 +2508,9 @@ public function getStatus() /** * 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) @@ -2149,6 +2522,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2158,7 +2532,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2170,6 +2546,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2179,7 +2556,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2191,6 +2570,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2200,7 +2580,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2212,6 +2594,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2221,7 +2604,9 @@ public function getTabId() /** * 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) @@ -2233,6 +2618,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2242,7 +2628,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2254,6 +2642,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2263,7 +2652,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2275,6 +2666,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2284,7 +2676,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2296,6 +2690,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2305,7 +2700,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2317,6 +2714,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2326,7 +2724,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2338,6 +2738,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2347,7 +2748,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2359,6 +2762,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2368,7 +2772,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2380,6 +2786,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2389,7 +2796,9 @@ public function getTemplateLocked() /** * 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) @@ -2401,6 +2810,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2410,7 +2820,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2422,6 +2834,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2431,7 +2844,9 @@ public function getTemplateRequired() /** * 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) @@ -2443,6 +2858,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2452,7 +2868,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2464,6 +2882,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2473,7 +2892,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2485,6 +2906,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2494,7 +2916,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2506,6 +2930,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2515,7 +2940,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2527,6 +2954,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2536,7 +2964,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2548,6 +2978,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2557,7 +2988,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2569,6 +3002,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2578,7 +3012,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2590,6 +3026,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2599,7 +3036,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2611,6 +3050,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2620,7 +3060,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2632,6 +3074,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2641,7 +3084,9 @@ public function getXPosition() /** * 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) @@ -2653,6 +3098,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2662,7 +3108,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2674,6 +3122,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2683,7 +3132,9 @@ public function getYPosition() /** * 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) @@ -2695,6 +3146,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2704,7 +3156,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2715,7 +3169,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2725,7 +3181,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2735,8 +3193,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2750,7 +3210,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2760,16 +3222,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UsageHistory.php b/src/Model/UsageHistory.php index 3a11bdc8..743f5b79 100644 --- a/src/Model/UsageHistory.php +++ b/src/Model/UsageHistory.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UsageHistory Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UsageHistory implements ArrayAccess +class UsageHistory implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'usageHistory'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -61,13 +64,42 @@ class UsageHistory implements ArrayAccess 'signed_count' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'last_sent_date_time' => null, + 'last_signed_date_time' => null, + 'sent_count' => null, + 'signed_count' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -77,9 +109,9 @@ public static function swaggerTypes() 'signed_count' => 'signedCount' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -89,9 +121,9 @@ public static function swaggerTypes() 'signed_count' => 'setSignedCount' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -101,34 +133,63 @@ public static function swaggerTypes() 'signed_count' => 'getSignedCount' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -139,30 +200,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets last_sent_date_time + * * @return string */ public function getLastSentDateTime() @@ -172,7 +235,9 @@ public function getLastSentDateTime() /** * Sets last_sent_date_time + * * @param string $last_sent_date_time The date and time the user last sent an envelope. + * * @return $this */ public function setLastSentDateTime($last_sent_date_time) @@ -184,6 +249,7 @@ public function setLastSentDateTime($last_sent_date_time) /** * Gets last_signed_date_time + * * @return string */ public function getLastSignedDateTime() @@ -193,7 +259,9 @@ public function getLastSignedDateTime() /** * Sets last_signed_date_time + * * @param string $last_signed_date_time The date and time the user last signed an envelope. + * * @return $this */ public function setLastSignedDateTime($last_signed_date_time) @@ -205,6 +273,7 @@ public function setLastSignedDateTime($last_signed_date_time) /** * Gets sent_count + * * @return string */ public function getSentCount() @@ -214,7 +283,9 @@ public function getSentCount() /** * Sets sent_count + * * @param string $sent_count The number of envelopes the user has sent. + * * @return $this */ public function setSentCount($sent_count) @@ -226,6 +297,7 @@ public function setSentCount($sent_count) /** * Gets signed_count + * * @return string */ public function getSignedCount() @@ -235,7 +307,9 @@ public function getSignedCount() /** * Sets signed_count + * * @param string $signed_count The number of envelopes the user has signed. + * * @return $this */ public function setSignedCount($signed_count) @@ -246,7 +320,9 @@ public function setSignedCount($signed_count) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -256,7 +332,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -266,8 +344,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -281,7 +361,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -291,16 +373,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserAccountManagementGranularInformation.php b/src/Model/UserAccountManagementGranularInformation.php index abe909f5..83e39949 100644 --- a/src/Model/UserAccountManagementGranularInformation.php +++ b/src/Model/UserAccountManagementGranularInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserAccountManagementGranularInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserAccountManagementGranularInformation implements ArrayAccess +class UserAccountManagementGranularInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userAccountManagementGranularInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -67,16 +70,57 @@ class UserAccountManagementGranularInformation implements ArrayAccess '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' + 'can_manage_users_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', + 'can_view_users' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'can_manage_account_security_settings' => null, + 'can_manage_account_security_settings_metadata' => null, + 'can_manage_account_settings' => null, + 'can_manage_account_settings_metadata' => null, + 'can_manage_admins' => null, + 'can_manage_admins_metadata' => null, + 'can_manage_reporting' => null, + 'can_manage_reporting_metadata' => null, + 'can_manage_sharing' => null, + 'can_manage_sharing_metadata' => null, + 'can_manage_signing_groups' => null, + 'can_manage_signing_groups_metadata' => null, + 'can_manage_users' => null, + 'can_manage_users_metadata' => null, + 'can_view_users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -93,12 +137,13 @@ public static function swaggerTypes() 'can_manage_signing_groups' => 'canManageSigningGroups', 'can_manage_signing_groups_metadata' => 'canManageSigningGroupsMetadata', 'can_manage_users' => 'canManageUsers', - 'can_manage_users_metadata' => 'canManageUsersMetadata' + 'can_manage_users_metadata' => 'canManageUsersMetadata', + 'can_view_users' => 'canViewUsers' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -115,12 +160,13 @@ public static function swaggerTypes() 'can_manage_signing_groups' => 'setCanManageSigningGroups', 'can_manage_signing_groups_metadata' => 'setCanManageSigningGroupsMetadata', 'can_manage_users' => 'setCanManageUsers', - 'can_manage_users_metadata' => 'setCanManageUsersMetadata' + 'can_manage_users_metadata' => 'setCanManageUsersMetadata', + 'can_view_users' => 'setCanViewUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -137,37 +183,67 @@ public static function swaggerTypes() 'can_manage_signing_groups' => 'getCanManageSigningGroups', 'can_manage_signing_groups_metadata' => 'getCanManageSigningGroupsMetadata', 'can_manage_users' => 'getCanManageUsers', - 'can_manage_users_metadata' => 'getCanManageUsersMetadata' + 'can_manage_users_metadata' => 'getCanManageUsersMetadata', + 'can_view_users' => 'getCanViewUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -185,33 +261,36 @@ public function __construct(array $data = 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; + $this->container['can_view_users'] = isset($data['can_view_users']) ? $data['can_view_users'] : null; } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets can_manage_account_security_settings + * * @return string */ public function getCanManageAccountSecuritySettings() @@ -221,7 +300,9 @@ public function getCanManageAccountSecuritySettings() /** * Sets can_manage_account_security_settings + * * @param string $can_manage_account_security_settings + * * @return $this */ public function setCanManageAccountSecuritySettings($can_manage_account_security_settings) @@ -233,6 +314,7 @@ public function setCanManageAccountSecuritySettings($can_manage_account_security /** * Gets can_manage_account_security_settings_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageAccountSecuritySettingsMetadata() @@ -242,7 +324,9 @@ public function getCanManageAccountSecuritySettingsMetadata() /** * Sets can_manage_account_security_settings_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_account_security_settings_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_account_security_settings_metadata can_manage_account_security_settings_metadata + * * @return $this */ public function setCanManageAccountSecuritySettingsMetadata($can_manage_account_security_settings_metadata) @@ -254,6 +338,7 @@ public function setCanManageAccountSecuritySettingsMetadata($can_manage_account_ /** * Gets can_manage_account_settings + * * @return string */ public function getCanManageAccountSettings() @@ -263,7 +348,9 @@ public function getCanManageAccountSettings() /** * Sets can_manage_account_settings + * * @param string $can_manage_account_settings + * * @return $this */ public function setCanManageAccountSettings($can_manage_account_settings) @@ -275,6 +362,7 @@ public function setCanManageAccountSettings($can_manage_account_settings) /** * Gets can_manage_account_settings_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageAccountSettingsMetadata() @@ -284,7 +372,9 @@ public function getCanManageAccountSettingsMetadata() /** * Sets can_manage_account_settings_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_account_settings_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_account_settings_metadata can_manage_account_settings_metadata + * * @return $this */ public function setCanManageAccountSettingsMetadata($can_manage_account_settings_metadata) @@ -296,6 +386,7 @@ public function setCanManageAccountSettingsMetadata($can_manage_account_settings /** * Gets can_manage_admins + * * @return string */ public function getCanManageAdmins() @@ -305,7 +396,9 @@ public function getCanManageAdmins() /** * Sets can_manage_admins + * * @param string $can_manage_admins + * * @return $this */ public function setCanManageAdmins($can_manage_admins) @@ -317,6 +410,7 @@ public function setCanManageAdmins($can_manage_admins) /** * Gets can_manage_admins_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageAdminsMetadata() @@ -326,7 +420,9 @@ public function getCanManageAdminsMetadata() /** * Sets can_manage_admins_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_admins_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_admins_metadata can_manage_admins_metadata + * * @return $this */ public function setCanManageAdminsMetadata($can_manage_admins_metadata) @@ -338,6 +434,7 @@ public function setCanManageAdminsMetadata($can_manage_admins_metadata) /** * Gets can_manage_reporting + * * @return string */ public function getCanManageReporting() @@ -347,7 +444,9 @@ public function getCanManageReporting() /** * Sets can_manage_reporting + * * @param string $can_manage_reporting + * * @return $this */ public function setCanManageReporting($can_manage_reporting) @@ -359,6 +458,7 @@ public function setCanManageReporting($can_manage_reporting) /** * Gets can_manage_reporting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageReportingMetadata() @@ -368,7 +468,9 @@ public function getCanManageReportingMetadata() /** * Sets can_manage_reporting_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_reporting_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_reporting_metadata can_manage_reporting_metadata + * * @return $this */ public function setCanManageReportingMetadata($can_manage_reporting_metadata) @@ -380,6 +482,7 @@ public function setCanManageReportingMetadata($can_manage_reporting_metadata) /** * Gets can_manage_sharing + * * @return string */ public function getCanManageSharing() @@ -389,7 +492,9 @@ public function getCanManageSharing() /** * Sets can_manage_sharing + * * @param string $can_manage_sharing + * * @return $this */ public function setCanManageSharing($can_manage_sharing) @@ -401,6 +506,7 @@ public function setCanManageSharing($can_manage_sharing) /** * Gets can_manage_sharing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageSharingMetadata() @@ -410,7 +516,9 @@ public function getCanManageSharingMetadata() /** * Sets can_manage_sharing_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_sharing_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_sharing_metadata can_manage_sharing_metadata + * * @return $this */ public function setCanManageSharingMetadata($can_manage_sharing_metadata) @@ -422,6 +530,7 @@ public function setCanManageSharingMetadata($can_manage_sharing_metadata) /** * Gets can_manage_signing_groups + * * @return string */ public function getCanManageSigningGroups() @@ -431,7 +540,9 @@ public function getCanManageSigningGroups() /** * Sets can_manage_signing_groups + * * @param string $can_manage_signing_groups + * * @return $this */ public function setCanManageSigningGroups($can_manage_signing_groups) @@ -443,6 +554,7 @@ public function setCanManageSigningGroups($can_manage_signing_groups) /** * Gets can_manage_signing_groups_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageSigningGroupsMetadata() @@ -452,7 +564,9 @@ public function getCanManageSigningGroupsMetadata() /** * Sets can_manage_signing_groups_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_signing_groups_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_signing_groups_metadata can_manage_signing_groups_metadata + * * @return $this */ public function setCanManageSigningGroupsMetadata($can_manage_signing_groups_metadata) @@ -464,6 +578,7 @@ public function setCanManageSigningGroupsMetadata($can_manage_signing_groups_met /** * Gets can_manage_users + * * @return string */ public function getCanManageUsers() @@ -473,7 +588,9 @@ public function getCanManageUsers() /** * Sets can_manage_users + * * @param string $can_manage_users + * * @return $this */ public function setCanManageUsers($can_manage_users) @@ -485,6 +602,7 @@ public function setCanManageUsers($can_manage_users) /** * Gets can_manage_users_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageUsersMetadata() @@ -494,7 +612,9 @@ public function getCanManageUsersMetadata() /** * Sets can_manage_users_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_users_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_users_metadata can_manage_users_metadata + * * @return $this */ public function setCanManageUsersMetadata($can_manage_users_metadata) @@ -503,9 +623,35 @@ public function setCanManageUsersMetadata($can_manage_users_metadata) return $this; } + + /** + * Gets can_view_users + * + * @return string + */ + public function getCanViewUsers() + { + return $this->container['can_view_users']; + } + + /** + * Sets can_view_users + * + * @param string $can_view_users + * + * @return $this + */ + public function setCanViewUsers($can_view_users) + { + $this->container['can_view_users'] = $can_view_users; + + return $this; + } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -515,7 +661,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -525,8 +673,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -540,7 +690,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -550,16 +702,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserInfo.php b/src/Model/UserInfo.php index 5afc4cb5..ebde0227 100644 --- a/src/Model/UserInfo.php +++ b/src/Model/UserInfo.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserInfo Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserInfo implements ArrayAccess +class UserInfo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userInfo'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -69,13 +72,51 @@ class UserInfo implements ArrayAccess 'user_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_id' => null, + 'account_name' => null, + 'activation_access_code' => null, + 'email' => null, + 'error_details' => null, + 'login_status' => null, + 'membership_id' => null, + 'send_activation_email' => null, + 'uri' => null, + 'user_id' => null, + 'user_name' => null, + 'user_status' => null, + 'user_type' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -94,9 +135,9 @@ public static function swaggerTypes() 'user_type' => 'userType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -115,9 +156,9 @@ public static function swaggerTypes() 'user_type' => 'setUserType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -136,34 +177,63 @@ public static function swaggerTypes() 'user_type' => 'getUserType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -183,30 +253,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_id + * * @return string */ public function getAccountId() @@ -216,7 +288,9 @@ public function getAccountId() /** * Sets account_id + * * @param string $account_id The account ID associated with the envelope. + * * @return $this */ public function setAccountId($account_id) @@ -228,6 +302,7 @@ public function setAccountId($account_id) /** * Gets account_name + * * @return string */ public function getAccountName() @@ -237,7 +312,9 @@ public function getAccountName() /** * Sets account_name + * * @param string $account_name + * * @return $this */ public function setAccountName($account_name) @@ -249,6 +326,7 @@ public function setAccountName($account_name) /** * Gets activation_access_code + * * @return string */ public function getActivationAccessCode() @@ -258,7 +336,9 @@ public function getActivationAccessCode() /** * Sets activation_access_code + * * @param string $activation_access_code + * * @return $this */ public function setActivationAccessCode($activation_access_code) @@ -270,6 +350,7 @@ public function setActivationAccessCode($activation_access_code) /** * Gets email + * * @return string */ public function getEmail() @@ -279,7 +360,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -291,6 +374,7 @@ public function setEmail($email) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -300,7 +384,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -312,6 +398,7 @@ public function setErrorDetails($error_details) /** * Gets login_status + * * @return string */ public function getLoginStatus() @@ -321,7 +408,9 @@ public function getLoginStatus() /** * Sets login_status + * * @param string $login_status + * * @return $this */ public function setLoginStatus($login_status) @@ -333,6 +422,7 @@ public function setLoginStatus($login_status) /** * Gets membership_id + * * @return string */ public function getMembershipId() @@ -342,7 +432,9 @@ public function getMembershipId() /** * Sets membership_id + * * @param string $membership_id + * * @return $this */ public function setMembershipId($membership_id) @@ -354,6 +446,7 @@ public function setMembershipId($membership_id) /** * Gets send_activation_email + * * @return string */ public function getSendActivationEmail() @@ -363,7 +456,9 @@ public function getSendActivationEmail() /** * Sets send_activation_email + * * @param string $send_activation_email + * * @return $this */ public function setSendActivationEmail($send_activation_email) @@ -375,6 +470,7 @@ public function setSendActivationEmail($send_activation_email) /** * Gets uri + * * @return string */ public function getUri() @@ -384,7 +480,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -396,6 +494,7 @@ public function setUri($uri) /** * Gets user_id + * * @return string */ public function getUserId() @@ -405,7 +504,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -417,6 +518,7 @@ public function setUserId($user_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -426,7 +528,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -438,6 +542,7 @@ public function setUserName($user_name) /** * Gets user_status + * * @return string */ public function getUserStatus() @@ -447,7 +552,9 @@ public function getUserStatus() /** * Sets user_status + * * @param string $user_status + * * @return $this */ public function setUserStatus($user_status) @@ -459,6 +566,7 @@ public function setUserStatus($user_status) /** * Gets user_type + * * @return string */ public function getUserType() @@ -468,7 +576,9 @@ public function getUserType() /** * Sets user_type + * * @param string $user_type + * * @return $this */ public function setUserType($user_type) @@ -479,7 +589,9 @@ public function setUserType($user_type) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -489,7 +601,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -499,8 +613,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -514,7 +630,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -524,16 +642,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserInfoList.php b/src/Model/UserInfoList.php index 69155f0a..31a14e17 100644 --- a/src/Model/UserInfoList.php +++ b/src/Model/UserInfoList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserInfoList Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserInfoList implements ArrayAccess +class UserInfoList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userInfoList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'users' => '\DocuSign\eSign\Model\UserInfo[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'users' => 'users' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'users' => 'setUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'users' => 'getUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getUsers() @@ -156,7 +216,9 @@ public function getUsers() /** * Sets users + * * @param \DocuSign\eSign\Model\UserInfo[] $users + * * @return $this */ public function setUsers($users) @@ -167,7 +229,9 @@ public function setUsers($users) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserInformation.php b/src/Model/UserInformation.php index ec7cfef8..09fd1809 100644 --- a/src/Model/UserInformation.php +++ b/src/Model/UserInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserInformation implements ArrayAccess +class UserInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -98,13 +101,80 @@ class UserInformation implements ArrayAccess 'work_address' => '\DocuSign\eSign\Model\AddressInformation' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'activation_access_code' => null, + 'company' => null, + 'connect_configurations' => null, + 'country_code' => null, + 'created_date_time' => null, + 'custom_settings' => null, + 'default_account_id' => null, + 'email' => null, + 'enable_connect_for_user' => null, + 'error_details' => null, + 'first_name' => null, + 'forgotten_password_info' => null, + 'group_list' => null, + 'home_address' => null, + 'initials_image_uri' => null, + 'is_admin' => null, + 'is_nar_enabled' => null, + 'job_title' => null, + 'last_login' => null, + 'last_name' => null, + 'login_status' => null, + 'middle_name' => null, + 'password' => null, + 'password_expiration' => null, + 'permission_profile_id' => null, + 'permission_profile_name' => null, + 'profile_image_uri' => null, + 'send_activation_email' => null, + 'send_activation_on_invalid_login' => null, + 'signature_image_uri' => null, + 'subscribe' => null, + 'suffix_name' => null, + 'title' => null, + 'uri' => null, + 'user_added_to_account_date_time' => null, + 'user_id' => null, + 'user_name' => null, + 'user_profile_last_modified_date' => null, + 'user_settings' => null, + 'user_status' => null, + 'user_type' => null, + 'work_address' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -152,9 +222,9 @@ public static function swaggerTypes() 'work_address' => 'workAddress' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -202,9 +272,9 @@ public static function swaggerTypes() 'work_address' => 'setWorkAddress' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -252,34 +322,63 @@ public static function swaggerTypes() 'work_address' => 'getWorkAddress' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -328,30 +427,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets activation_access_code + * * @return string */ public function getActivationAccessCode() @@ -361,7 +462,9 @@ public function getActivationAccessCode() /** * Sets activation_access_code + * * @param string $activation_access_code The activation code the new user must enter when activating their account. + * * @return $this */ public function setActivationAccessCode($activation_access_code) @@ -373,6 +476,7 @@ public function setActivationAccessCode($activation_access_code) /** * Gets company + * * @return string */ public function getCompany() @@ -382,7 +486,9 @@ public function getCompany() /** * Sets company + * * @param string $company + * * @return $this */ public function setCompany($company) @@ -394,6 +500,7 @@ public function setCompany($company) /** * Gets connect_configurations + * * @return \DocuSign\eSign\Model\ConnectUserObject[] */ public function getConnectConfigurations() @@ -403,7 +510,9 @@ public function getConnectConfigurations() /** * Sets connect_configurations + * * @param \DocuSign\eSign\Model\ConnectUserObject[] $connect_configurations + * * @return $this */ public function setConnectConfigurations($connect_configurations) @@ -415,6 +524,7 @@ public function setConnectConfigurations($connect_configurations) /** * Gets country_code + * * @return string */ public function getCountryCode() @@ -424,7 +534,9 @@ public function getCountryCode() /** * Sets country_code + * * @param string $country_code + * * @return $this */ public function setCountryCode($country_code) @@ -436,6 +548,7 @@ public function setCountryCode($country_code) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -445,7 +558,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -457,6 +572,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_settings + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getCustomSettings() @@ -466,7 +582,9 @@ public function getCustomSettings() /** * Sets custom_settings + * * @param \DocuSign\eSign\Model\NameValue[] $custom_settings The name/value pair information for the user custom setting. + * * @return $this */ public function setCustomSettings($custom_settings) @@ -478,6 +596,7 @@ public function setCustomSettings($custom_settings) /** * Gets default_account_id + * * @return string */ public function getDefaultAccountId() @@ -487,7 +606,9 @@ public function getDefaultAccountId() /** * Sets default_account_id + * * @param string $default_account_id + * * @return $this */ public function setDefaultAccountId($default_account_id) @@ -499,6 +620,7 @@ public function setDefaultAccountId($default_account_id) /** * Gets email + * * @return string */ public function getEmail() @@ -508,7 +630,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -520,6 +644,7 @@ public function setEmail($email) /** * Gets enable_connect_for_user + * * @return string */ public function getEnableConnectForUser() @@ -529,7 +654,9 @@ public function getEnableConnectForUser() /** * Sets enable_connect_for_user + * * @param string $enable_connect_for_user Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false. + * * @return $this */ public function setEnableConnectForUser($enable_connect_for_user) @@ -541,6 +668,7 @@ public function setEnableConnectForUser($enable_connect_for_user) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -550,7 +678,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -562,6 +692,7 @@ public function setErrorDetails($error_details) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -571,7 +702,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -583,6 +716,7 @@ public function setFirstName($first_name) /** * Gets forgotten_password_info + * * @return \DocuSign\eSign\Model\ForgottenPasswordInformation */ public function getForgottenPasswordInfo() @@ -592,7 +726,9 @@ public function getForgottenPasswordInfo() /** * Sets forgotten_password_info - * @param \DocuSign\eSign\Model\ForgottenPasswordInformation $forgotten_password_info + * + * @param \DocuSign\eSign\Model\ForgottenPasswordInformation $forgotten_password_info forgotten_password_info + * * @return $this */ public function setForgottenPasswordInfo($forgotten_password_info) @@ -604,6 +740,7 @@ public function setForgottenPasswordInfo($forgotten_password_info) /** * Gets group_list + * * @return \DocuSign\eSign\Model\Group[] */ public function getGroupList() @@ -613,7 +750,9 @@ 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. + * * @return $this */ public function setGroupList($group_list) @@ -625,6 +764,7 @@ public function setGroupList($group_list) /** * Gets home_address + * * @return \DocuSign\eSign\Model\AddressInformation */ public function getHomeAddress() @@ -634,7 +774,9 @@ public function getHomeAddress() /** * Sets home_address - * @param \DocuSign\eSign\Model\AddressInformation $home_address + * + * @param \DocuSign\eSign\Model\AddressInformation $home_address home_address + * * @return $this */ public function setHomeAddress($home_address) @@ -646,6 +788,7 @@ public function setHomeAddress($home_address) /** * Gets initials_image_uri + * * @return string */ public function getInitialsImageUri() @@ -655,7 +798,9 @@ public function getInitialsImageUri() /** * Sets initials_image_uri + * * @param string $initials_image_uri Contains the URI for an endpoint that you can use to retrieve the initials image. + * * @return $this */ public function setInitialsImageUri($initials_image_uri) @@ -667,6 +812,7 @@ public function setInitialsImageUri($initials_image_uri) /** * Gets is_admin + * * @return string */ public function getIsAdmin() @@ -676,7 +822,9 @@ public function getIsAdmin() /** * Sets is_admin + * * @param string $is_admin Determines if the feature set is actively set as part of the plan. + * * @return $this */ public function setIsAdmin($is_admin) @@ -688,6 +836,7 @@ public function setIsAdmin($is_admin) /** * Gets is_nar_enabled + * * @return string */ public function getIsNarEnabled() @@ -697,7 +846,9 @@ public function getIsNarEnabled() /** * Sets is_nar_enabled + * * @param string $is_nar_enabled + * * @return $this */ public function setIsNarEnabled($is_nar_enabled) @@ -709,6 +860,7 @@ public function setIsNarEnabled($is_nar_enabled) /** * Gets job_title + * * @return string */ public function getJobTitle() @@ -718,7 +870,9 @@ public function getJobTitle() /** * Sets job_title + * * @param string $job_title + * * @return $this */ public function setJobTitle($job_title) @@ -730,6 +884,7 @@ public function setJobTitle($job_title) /** * Gets last_login + * * @return string */ public function getLastLogin() @@ -739,7 +894,9 @@ public function getLastLogin() /** * Sets last_login + * * @param string $last_login Shows the date-time when the user last logged on to the system. + * * @return $this */ public function setLastLogin($last_login) @@ -751,6 +908,7 @@ public function setLastLogin($last_login) /** * Gets last_name + * * @return string */ public function getLastName() @@ -760,7 +918,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name The user's last name. Maximum Length: 50 characters. + * * @return $this */ public function setLastName($last_name) @@ -772,6 +932,7 @@ public function setLastName($last_name) /** * Gets login_status + * * @return string */ public function getLoginStatus() @@ -781,7 +942,9 @@ 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 + * * @return $this */ public function setLoginStatus($login_status) @@ -793,6 +956,7 @@ public function setLoginStatus($login_status) /** * Gets middle_name + * * @return string */ public function getMiddleName() @@ -802,7 +966,9 @@ public function getMiddleName() /** * Sets middle_name + * * @param string $middle_name The user's middle name. Maximum Length: 50 characters. + * * @return $this */ public function setMiddleName($middle_name) @@ -814,6 +980,7 @@ public function setMiddleName($middle_name) /** * Gets password + * * @return string */ public function getPassword() @@ -823,7 +990,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -835,6 +1004,7 @@ public function setPassword($password) /** * Gets password_expiration + * * @return string */ public function getPasswordExpiration() @@ -844,7 +1014,9 @@ public function getPasswordExpiration() /** * Sets password_expiration + * * @param string $password_expiration + * * @return $this */ public function setPasswordExpiration($password_expiration) @@ -856,6 +1028,7 @@ public function setPasswordExpiration($password_expiration) /** * Gets permission_profile_id + * * @return string */ public function getPermissionProfileId() @@ -865,7 +1038,9 @@ public function getPermissionProfileId() /** * Sets permission_profile_id + * * @param string $permission_profile_id + * * @return $this */ public function setPermissionProfileId($permission_profile_id) @@ -877,6 +1052,7 @@ public function setPermissionProfileId($permission_profile_id) /** * Gets permission_profile_name + * * @return string */ public function getPermissionProfileName() @@ -886,7 +1062,9 @@ public function getPermissionProfileName() /** * Sets permission_profile_name + * * @param string $permission_profile_name + * * @return $this */ public function setPermissionProfileName($permission_profile_name) @@ -898,6 +1076,7 @@ public function setPermissionProfileName($permission_profile_name) /** * Gets profile_image_uri + * * @return string */ public function getProfileImageUri() @@ -907,7 +1086,9 @@ public function getProfileImageUri() /** * Sets profile_image_uri + * * @param string $profile_image_uri + * * @return $this */ public function setProfileImageUri($profile_image_uri) @@ -919,6 +1100,7 @@ public function setProfileImageUri($profile_image_uri) /** * Gets send_activation_email + * * @return string */ public function getSendActivationEmail() @@ -928,7 +1110,9 @@ public function getSendActivationEmail() /** * Sets send_activation_email + * * @param string $send_activation_email + * * @return $this */ public function setSendActivationEmail($send_activation_email) @@ -940,6 +1124,7 @@ public function setSendActivationEmail($send_activation_email) /** * Gets send_activation_on_invalid_login + * * @return string */ public function getSendActivationOnInvalidLogin() @@ -949,7 +1134,9 @@ public function getSendActivationOnInvalidLogin() /** * Sets send_activation_on_invalid_login + * * @param string $send_activation_on_invalid_login When set to **true**, specifies that an additional activation email is sent to the user if they fail a log on before activating their account. + * * @return $this */ public function setSendActivationOnInvalidLogin($send_activation_on_invalid_login) @@ -961,6 +1148,7 @@ public function setSendActivationOnInvalidLogin($send_activation_on_invalid_logi /** * Gets signature_image_uri + * * @return string */ public function getSignatureImageUri() @@ -970,7 +1158,9 @@ public function getSignatureImageUri() /** * Sets signature_image_uri + * * @param string $signature_image_uri Contains the URI for an endpoint that you can use to retrieve the signature image. + * * @return $this */ public function setSignatureImageUri($signature_image_uri) @@ -982,6 +1172,7 @@ public function setSignatureImageUri($signature_image_uri) /** * Gets subscribe + * * @return string */ public function getSubscribe() @@ -991,7 +1182,9 @@ public function getSubscribe() /** * Sets subscribe + * * @param string $subscribe + * * @return $this */ public function setSubscribe($subscribe) @@ -1003,6 +1196,7 @@ public function setSubscribe($subscribe) /** * Gets suffix_name + * * @return string */ public function getSuffixName() @@ -1012,7 +1206,9 @@ public function getSuffixName() /** * Sets suffix_name + * * @param string $suffix_name The suffix for the user's name. Maximum Length: 50 characters. + * * @return $this */ public function setSuffixName($suffix_name) @@ -1024,6 +1220,7 @@ public function setSuffixName($suffix_name) /** * Gets title + * * @return string */ public function getTitle() @@ -1033,7 +1230,9 @@ public function getTitle() /** * Sets title + * * @param string $title The title of the user. + * * @return $this */ public function setTitle($title) @@ -1045,6 +1244,7 @@ public function setTitle($title) /** * Gets uri + * * @return string */ public function getUri() @@ -1054,7 +1254,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -1066,6 +1268,7 @@ public function setUri($uri) /** * Gets user_added_to_account_date_time + * * @return string */ public function getUserAddedToAccountDateTime() @@ -1075,7 +1278,9 @@ public function getUserAddedToAccountDateTime() /** * Sets user_added_to_account_date_time + * * @param string $user_added_to_account_date_time + * * @return $this */ public function setUserAddedToAccountDateTime($user_added_to_account_date_time) @@ -1087,6 +1292,7 @@ public function setUserAddedToAccountDateTime($user_added_to_account_date_time) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1096,7 +1302,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1108,6 +1316,7 @@ public function setUserId($user_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -1117,7 +1326,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -1129,6 +1340,7 @@ public function setUserName($user_name) /** * Gets user_profile_last_modified_date + * * @return string */ public function getUserProfileLastModifiedDate() @@ -1138,7 +1350,9 @@ public function getUserProfileLastModifiedDate() /** * Sets user_profile_last_modified_date + * * @param string $user_profile_last_modified_date + * * @return $this */ public function setUserProfileLastModifiedDate($user_profile_last_modified_date) @@ -1150,6 +1364,7 @@ public function setUserProfileLastModifiedDate($user_profile_last_modified_date) /** * Gets user_settings + * * @return \DocuSign\eSign\Model\UserSettingsInformation */ public function getUserSettings() @@ -1159,7 +1374,9 @@ public function getUserSettings() /** * Sets user_settings - * @param \DocuSign\eSign\Model\UserSettingsInformation $user_settings + * + * @param \DocuSign\eSign\Model\UserSettingsInformation $user_settings user_settings + * * @return $this */ public function setUserSettings($user_settings) @@ -1171,6 +1388,7 @@ public function setUserSettings($user_settings) /** * Gets user_status + * * @return string */ public function getUserStatus() @@ -1180,7 +1398,9 @@ public function getUserStatus() /** * Sets user_status + * * @param string $user_status + * * @return $this */ public function setUserStatus($user_status) @@ -1192,6 +1412,7 @@ public function setUserStatus($user_status) /** * Gets user_type + * * @return string */ public function getUserType() @@ -1201,7 +1422,9 @@ public function getUserType() /** * Sets user_type + * * @param string $user_type + * * @return $this */ public function setUserType($user_type) @@ -1213,6 +1436,7 @@ public function setUserType($user_type) /** * Gets work_address + * * @return \DocuSign\eSign\Model\AddressInformation */ public function getWorkAddress() @@ -1222,7 +1446,9 @@ public function getWorkAddress() /** * Sets work_address - * @param \DocuSign\eSign\Model\AddressInformation $work_address + * + * @param \DocuSign\eSign\Model\AddressInformation $work_address work_address + * * @return $this */ public function setWorkAddress($work_address) @@ -1233,7 +1459,9 @@ public function setWorkAddress($work_address) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -1243,7 +1471,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1253,8 +1483,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1268,7 +1500,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1278,16 +1512,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserInformationList.php b/src/Model/UserInformationList.php index 7c9361bf..cc95feba 100644 --- a/src/Model/UserInformationList.php +++ b/src/Model/UserInformationList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserInformationList Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserInformationList implements ArrayAccess +class UserInformationList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userInformationList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class UserInformationList implements ArrayAccess 'users' => '\DocuSign\eSign\Model\UserInformation[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null, + 'users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'users' => 'users' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'users' => 'setUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'users' => 'getUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -207,7 +276,9 @@ public function getNextUri() /** * 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) @@ -219,6 +290,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -228,7 +300,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -240,6 +314,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -249,7 +324,9 @@ public function getResultSetSize() /** * 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) @@ -261,6 +338,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -270,7 +348,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -282,6 +362,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -291,7 +372,9 @@ public function getTotalSetSize() /** * 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) @@ -303,6 +386,7 @@ public function setTotalSetSize($total_set_size) /** * Gets users + * * @return \DocuSign\eSign\Model\UserInformation[] */ public function getUsers() @@ -312,7 +396,9 @@ public function getUsers() /** * Sets users + * * @param \DocuSign\eSign\Model\UserInformation[] $users + * * @return $this */ public function setUsers($users) @@ -323,7 +409,9 @@ public function setUsers($users) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserPasswordInformation.php b/src/Model/UserPasswordInformation.php index 1afea87d..acb070ac 100644 --- a/src/Model/UserPasswordInformation.php +++ b/src/Model/UserPasswordInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserPasswordInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserPasswordInformation implements ArrayAccess +class UserPasswordInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userPasswordInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class UserPasswordInformation implements ArrayAccess 'new_password' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'current_password' => null, + 'email' => null, + 'forgotten_password_info' => null, + 'new_password' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'new_password' => 'newPassword' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'new_password' => 'setNewPassword' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'new_password' => 'getNewPassword' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -138,30 +199,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets current_password + * * @return string */ public function getCurrentPassword() @@ -171,7 +234,9 @@ public function getCurrentPassword() /** * Sets current_password + * * @param string $current_password The user's current password to be changed. + * * @return $this */ public function setCurrentPassword($current_password) @@ -183,6 +248,7 @@ public function setCurrentPassword($current_password) /** * Gets email + * * @return string */ public function getEmail() @@ -192,7 +258,9 @@ public function getEmail() /** * Sets email + * * @param string $email The user's email address for the associated account. + * * @return $this */ public function setEmail($email) @@ -204,6 +272,7 @@ public function setEmail($email) /** * Gets forgotten_password_info + * * @return \DocuSign\eSign\Model\ForgottenPasswordInformation */ public function getForgottenPasswordInfo() @@ -213,7 +282,9 @@ public function getForgottenPasswordInfo() /** * Sets forgotten_password_info - * @param \DocuSign\eSign\Model\ForgottenPasswordInformation $forgotten_password_info + * + * @param \DocuSign\eSign\Model\ForgottenPasswordInformation $forgotten_password_info forgotten_password_info + * * @return $this */ public function setForgottenPasswordInfo($forgotten_password_info) @@ -225,6 +296,7 @@ public function setForgottenPasswordInfo($forgotten_password_info) /** * Gets new_password + * * @return string */ public function getNewPassword() @@ -234,7 +306,9 @@ public function getNewPassword() /** * Sets new_password + * * @param string $new_password The user's new password. + * * @return $this */ public function setNewPassword($new_password) @@ -245,7 +319,9 @@ public function setNewPassword($new_password) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -255,7 +331,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -265,8 +343,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -280,7 +360,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -290,16 +372,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserPasswordRules.php b/src/Model/UserPasswordRules.php index e6171290..0dd50531 100644 --- a/src/Model/UserPasswordRules.php +++ b/src/Model/UserPasswordRules.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserPasswordRules Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserPasswordRules implements ArrayAccess +class UserPasswordRules implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userPasswordRules'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class UserPasswordRules implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'password_rules' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets password_rules + * * @return \DocuSign\eSign\Model\AccountPasswordRules */ public function getPasswordRules() @@ -161,7 +222,9 @@ public function getPasswordRules() /** * Sets password_rules - * @param \DocuSign\eSign\Model\AccountPasswordRules $password_rules + * + * @param \DocuSign\eSign\Model\AccountPasswordRules $password_rules password_rules + * * @return $this */ public function setPasswordRules($password_rules) @@ -173,6 +236,7 @@ public function setPasswordRules($password_rules) /** * Gets user_id + * * @return string */ public function getUserId() @@ -182,7 +246,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -193,7 +259,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserProfile.php b/src/Model/UserProfile.php index ebb7a26c..e72177c8 100644 --- a/src/Model/UserProfile.php +++ b/src/Model/UserProfile.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserProfile Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserProfile implements ArrayAccess +class UserProfile implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userProfile'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -68,13 +71,50 @@ class UserProfile implements ArrayAccess 'user_profile_last_modified_date' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'address' => null, + 'authentication_methods' => null, + 'company_name' => null, + 'display_organization_info' => null, + 'display_personal_info' => null, + 'display_profile' => null, + 'display_usage_history' => null, + 'profile_image_uri' => null, + 'title' => null, + 'usage_history' => null, + 'user_details' => null, + 'user_profile_last_modified_date' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -92,9 +132,9 @@ public static function swaggerTypes() 'user_profile_last_modified_date' => 'userProfileLastModifiedDate' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,9 +152,9 @@ public static function swaggerTypes() 'user_profile_last_modified_date' => 'setUserProfileLastModifiedDate' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -132,34 +172,63 @@ public static function swaggerTypes() 'user_profile_last_modified_date' => 'getUserProfileLastModifiedDate' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -178,30 +247,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets address + * * @return \DocuSign\eSign\Model\AddressInformation */ public function getAddress() @@ -211,7 +282,9 @@ public function getAddress() /** * Sets address - * @param \DocuSign\eSign\Model\AddressInformation $address + * + * @param \DocuSign\eSign\Model\AddressInformation $address address + * * @return $this */ public function setAddress($address) @@ -223,6 +296,7 @@ public function setAddress($address) /** * Gets authentication_methods + * * @return \DocuSign\eSign\Model\AuthenticationMethod[] */ public function getAuthenticationMethods() @@ -232,7 +306,9 @@ public function getAuthenticationMethods() /** * Sets authentication_methods + * * @param \DocuSign\eSign\Model\AuthenticationMethod[] $authentication_methods These properties cannot be modified in the PUT. Indicates the authentication methods used by the user. + * * @return $this */ public function setAuthenticationMethods($authentication_methods) @@ -244,6 +320,7 @@ public function setAuthenticationMethods($authentication_methods) /** * Gets company_name + * * @return string */ public function getCompanyName() @@ -253,7 +330,9 @@ public function getCompanyName() /** * Sets company_name + * * @param string $company_name The name of the user's Company. + * * @return $this */ public function setCompanyName($company_name) @@ -265,6 +344,7 @@ public function setCompanyName($company_name) /** * Gets display_organization_info + * * @return string */ public function getDisplayOrganizationInfo() @@ -274,7 +354,9 @@ public function getDisplayOrganizationInfo() /** * Sets display_organization_info + * * @param string $display_organization_info When set to **true**, the user's company and title information are shown on the ID card. + * * @return $this */ public function setDisplayOrganizationInfo($display_organization_info) @@ -286,6 +368,7 @@ public function setDisplayOrganizationInfo($display_organization_info) /** * Gets display_personal_info + * * @return string */ public function getDisplayPersonalInfo() @@ -295,7 +378,9 @@ public function getDisplayPersonalInfo() /** * Sets display_personal_info + * * @param string $display_personal_info When set to **true**, the user's Address and Phone number are shown on the ID card. + * * @return $this */ public function setDisplayPersonalInfo($display_personal_info) @@ -307,6 +392,7 @@ public function setDisplayPersonalInfo($display_personal_info) /** * Gets display_profile + * * @return string */ public function getDisplayProfile() @@ -316,7 +402,9 @@ public function getDisplayProfile() /** * Sets display_profile + * * @param string $display_profile When set to **true**, the user's ID card can be viewed from signed documents and envelope history. + * * @return $this */ public function setDisplayProfile($display_profile) @@ -328,6 +416,7 @@ public function setDisplayProfile($display_profile) /** * Gets display_usage_history + * * @return string */ public function getDisplayUsageHistory() @@ -337,7 +426,9 @@ public function getDisplayUsageHistory() /** * Sets display_usage_history + * * @param string $display_usage_history When set to **true**, the user's usage information is shown on the ID card. + * * @return $this */ public function setDisplayUsageHistory($display_usage_history) @@ -349,6 +440,7 @@ public function setDisplayUsageHistory($display_usage_history) /** * Gets profile_image_uri + * * @return string */ public function getProfileImageUri() @@ -358,7 +450,9 @@ public function getProfileImageUri() /** * Sets profile_image_uri + * * @param string $profile_image_uri + * * @return $this */ public function setProfileImageUri($profile_image_uri) @@ -370,6 +464,7 @@ public function setProfileImageUri($profile_image_uri) /** * Gets title + * * @return string */ public function getTitle() @@ -379,7 +474,9 @@ public function getTitle() /** * Sets title + * * @param string $title + * * @return $this */ public function setTitle($title) @@ -391,6 +488,7 @@ public function setTitle($title) /** * Gets usage_history + * * @return \DocuSign\eSign\Model\UsageHistory */ public function getUsageHistory() @@ -400,7 +498,9 @@ public function getUsageHistory() /** * Sets usage_history - * @param \DocuSign\eSign\Model\UsageHistory $usage_history + * + * @param \DocuSign\eSign\Model\UsageHistory $usage_history usage_history + * * @return $this */ public function setUsageHistory($usage_history) @@ -412,6 +512,7 @@ public function setUsageHistory($usage_history) /** * Gets user_details + * * @return \DocuSign\eSign\Model\UserInformation */ public function getUserDetails() @@ -421,7 +522,9 @@ public function getUserDetails() /** * Sets user_details - * @param \DocuSign\eSign\Model\UserInformation $user_details + * + * @param \DocuSign\eSign\Model\UserInformation $user_details user_details + * * @return $this */ public function setUserDetails($user_details) @@ -433,6 +536,7 @@ public function setUserDetails($user_details) /** * Gets user_profile_last_modified_date + * * @return string */ public function getUserProfileLastModifiedDate() @@ -442,7 +546,9 @@ public function getUserProfileLastModifiedDate() /** * Sets user_profile_last_modified_date + * * @param string $user_profile_last_modified_date + * * @return $this */ public function setUserProfileLastModifiedDate($user_profile_last_modified_date) @@ -453,7 +559,9 @@ public function setUserProfileLastModifiedDate($user_profile_last_modified_date) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -463,7 +571,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -473,8 +583,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -488,7 +600,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -498,16 +612,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserSettingsInformation.php b/src/Model/UserSettingsInformation.php index 41a25a7b..1f0e63fa 100644 --- a/src/Model/UserSettingsInformation.php +++ b/src/Model/UserSettingsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserSettingsInformation Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserSettingsInformation implements ArrayAccess +class UserSettingsInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userSettingsInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -175,13 +178,157 @@ class UserSettingsInformation implements ArrayAccess 'vaulting_mode_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_management_granular' => null, + 'admin_only' => null, + 'admin_only_metadata' => null, + 'allow_auto_tagging' => null, + 'allow_envelope_transfer_to' => null, + 'allow_envelope_transfer_to_metadata' => null, + 'allow_eseal_recipients' => null, + 'allow_eseal_recipients_metadata' => null, + 'allow_power_forms_admin_to_access_all_power_form_envelope' => null, + 'allow_power_forms_admin_to_access_all_power_form_envelope_metadata' => null, + 'allow_recipient_language_selection' => null, + 'allow_recipient_language_selection_metadata' => null, + 'allow_send_on_behalf_of' => null, + 'allow_send_on_behalf_of_metadata' => null, + 'allow_supplemental_documents' => null, + 'allow_supplemental_documents_metadata' => null, + 'anchor_tag_versioned_placement_enabled' => null, + 'api_account_wide_access' => null, + 'api_account_wide_access_metadata' => null, + 'api_can_export_ac' => null, + 'api_can_export_ac_metadata' => null, + 'bulk_send' => null, + 'bulk_send_metadata' => null, + 'can_charge_account' => null, + 'can_charge_account_metadata' => null, + 'can_edit_shared_addressbook' => null, + 'can_edit_shared_addressbook_metadata' => null, + 'can_lock_envelopes' => null, + 'can_lock_envelopes_metadata' => null, + 'can_manage_account' => null, + 'can_manage_account_metadata' => null, + 'can_manage_distributor' => null, + 'can_manage_distributor_metadata' => null, + 'can_manage_templates' => null, + 'can_manage_templates_metadata' => null, + 'can_send_api_requests' => null, + 'can_send_api_requests_metadata' => null, + 'can_send_envelope' => null, + 'can_send_envelope_metadata' => null, + 'can_sign_envelope' => null, + 'can_sign_envelope_metadata' => null, + 'can_use_scratchpad' => null, + 'can_use_scratchpad_metadata' => null, + 'can_use_smart_contracts' => null, + 'can_use_smart_contracts_metadata' => null, + 'disable_document_upload' => null, + 'disable_document_upload_metadata' => null, + 'disable_other_actions' => null, + 'disable_other_actions_metadata' => null, + 'enable_ds_pro' => null, + 'enable_ds_pro_metadata' => null, + 'enable_sequential_signing_api' => null, + 'enable_sequential_signing_api_metadata' => null, + 'enable_sequential_signing_ui' => null, + 'enable_sequential_signing_ui_metadata' => null, + 'enable_signer_attachments' => null, + 'enable_signer_attachments_metadata' => null, + 'enable_sign_on_paper_override' => null, + 'enable_sign_on_paper_override_metadata' => null, + 'enable_transaction_point' => null, + 'enable_transaction_point_metadata' => null, + 'enable_vaulting' => null, + 'enable_vaulting_metadata' => null, + 'express_send_only' => null, + 'locale' => null, + 'locale_metadata' => null, + 'locale_policy' => null, + 'manage_clickwraps_mode' => null, + 'manage_clickwraps_mode_metadata' => null, + 'modified_by' => null, + 'modified_by_metadata' => null, + 'modified_date' => null, + 'modified_date_metadata' => null, + 'modified_page' => null, + 'modified_page_metadata' => null, + 'new_send_ui' => null, + 'new_send_ui_metadata' => null, + 'power_form_mode' => null, + 'power_form_mode_metadata' => null, + 'recipient_viewed_notification' => null, + 'recipient_viewed_notification_metadata' => null, + 'seal_identifiers' => null, + 'self_signed_recipient_email_document' => null, + 'self_signed_recipient_email_document_metadata' => null, + 'sender_email_notifications' => null, + 'signer_email_notifications' => null, + 'supplemental_document_include_in_download' => null, + 'supplemental_documents_must_accept' => null, + 'supplemental_documents_must_accept_metadata' => null, + 'supplemental_documents_must_read' => null, + 'supplemental_documents_must_read_metadata' => null, + 'supplemental_documents_must_view' => null, + 'supplemental_documents_must_view_metadata' => null, + 'template_active_creation' => null, + 'template_active_creation_metadata' => null, + 'template_apply_notify' => null, + 'template_apply_notify_metadata' => null, + 'template_auto_matching' => null, + 'template_auto_matching_metadata' => null, + 'template_matching_sensitivity' => null, + 'template_matching_sensitivity_metadata' => null, + 'template_page_level_matching' => null, + 'template_page_level_matching_metadata' => null, + 'timezone_dst' => null, + 'timezone_dst_metadata' => null, + 'timezone_mask' => null, + 'timezone_mask_metadata' => null, + 'timezone_offset' => null, + 'timezone_offset_metadata' => null, + 'timezone_sending_pref' => null, + 'timezone_sending_pref_metadata' => null, + 'timezone_signing_pref' => null, + 'timezone_signing_pref_metadata' => null, + 'transaction_point_site_name_url' => null, + 'transaction_point_site_name_url_metadata' => null, + 'transaction_point_user_name' => null, + 'transaction_point_user_name_metadata' => null, + 'vaulting_mode' => null, + 'vaulting_mode_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -306,9 +453,9 @@ public static function swaggerTypes() 'vaulting_mode_metadata' => 'vaultingModeMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -433,9 +580,9 @@ public static function swaggerTypes() 'vaulting_mode_metadata' => 'setVaultingModeMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -560,34 +707,63 @@ public static function swaggerTypes() 'vaulting_mode_metadata' => 'getVaultingModeMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -713,30 +889,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_management_granular + * * @return \DocuSign\eSign\Model\UserAccountManagementGranularInformation */ public function getAccountManagementGranular() @@ -746,7 +924,9 @@ public function getAccountManagementGranular() /** * Sets account_management_granular - * @param \DocuSign\eSign\Model\UserAccountManagementGranularInformation $account_management_granular + * + * @param \DocuSign\eSign\Model\UserAccountManagementGranularInformation $account_management_granular account_management_granular + * * @return $this */ public function setAccountManagementGranular($account_management_granular) @@ -758,6 +938,7 @@ public function setAccountManagementGranular($account_management_granular) /** * Gets admin_only + * * @return string */ public function getAdminOnly() @@ -767,7 +948,9 @@ public function getAdminOnly() /** * Sets admin_only + * * @param string $admin_only + * * @return $this */ public function setAdminOnly($admin_only) @@ -779,6 +962,7 @@ public function setAdminOnly($admin_only) /** * Gets admin_only_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAdminOnlyMetadata() @@ -788,7 +972,9 @@ public function getAdminOnlyMetadata() /** * Sets admin_only_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $admin_only_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $admin_only_metadata admin_only_metadata + * * @return $this */ public function setAdminOnlyMetadata($admin_only_metadata) @@ -800,6 +986,7 @@ public function setAdminOnlyMetadata($admin_only_metadata) /** * Gets allow_auto_tagging + * * @return string */ public function getAllowAutoTagging() @@ -809,7 +996,9 @@ public function getAllowAutoTagging() /** * Sets allow_auto_tagging + * * @param string $allow_auto_tagging + * * @return $this */ public function setAllowAutoTagging($allow_auto_tagging) @@ -821,6 +1010,7 @@ public function setAllowAutoTagging($allow_auto_tagging) /** * Gets allow_envelope_transfer_to + * * @return string */ public function getAllowEnvelopeTransferTo() @@ -830,7 +1020,9 @@ public function getAllowEnvelopeTransferTo() /** * Sets allow_envelope_transfer_to + * * @param string $allow_envelope_transfer_to + * * @return $this */ public function setAllowEnvelopeTransferTo($allow_envelope_transfer_to) @@ -842,6 +1034,7 @@ public function setAllowEnvelopeTransferTo($allow_envelope_transfer_to) /** * Gets allow_envelope_transfer_to_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEnvelopeTransferToMetadata() @@ -851,7 +1044,9 @@ public function getAllowEnvelopeTransferToMetadata() /** * Sets allow_envelope_transfer_to_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_transfer_to_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_envelope_transfer_to_metadata allow_envelope_transfer_to_metadata + * * @return $this */ public function setAllowEnvelopeTransferToMetadata($allow_envelope_transfer_to_metadata) @@ -863,6 +1058,7 @@ public function setAllowEnvelopeTransferToMetadata($allow_envelope_transfer_to_m /** * Gets allow_eseal_recipients + * * @return string */ public function getAllowEsealRecipients() @@ -872,7 +1068,9 @@ public function getAllowEsealRecipients() /** * Sets allow_eseal_recipients + * * @param string $allow_eseal_recipients + * * @return $this */ public function setAllowEsealRecipients($allow_eseal_recipients) @@ -884,6 +1082,7 @@ public function setAllowEsealRecipients($allow_eseal_recipients) /** * Gets allow_eseal_recipients_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEsealRecipientsMetadata() @@ -893,7 +1092,9 @@ public function getAllowEsealRecipientsMetadata() /** * Sets allow_eseal_recipients_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_eseal_recipients_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_eseal_recipients_metadata allow_eseal_recipients_metadata + * * @return $this */ public function setAllowEsealRecipientsMetadata($allow_eseal_recipients_metadata) @@ -905,6 +1106,7 @@ public function setAllowEsealRecipientsMetadata($allow_eseal_recipients_metadata /** * Gets allow_power_forms_admin_to_access_all_power_form_envelope + * * @return string */ public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelope() @@ -914,7 +1116,9 @@ public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelope() /** * Sets allow_power_forms_admin_to_access_all_power_form_envelope + * * @param string $allow_power_forms_admin_to_access_all_power_form_envelope + * * @return $this */ public function setAllowPowerFormsAdminToAccessAllPowerFormEnvelope($allow_power_forms_admin_to_access_all_power_form_envelope) @@ -926,6 +1130,7 @@ public function setAllowPowerFormsAdminToAccessAllPowerFormEnvelope($allow_power /** * Gets allow_power_forms_admin_to_access_all_power_form_envelope_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata() @@ -935,7 +1140,9 @@ public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata() /** * Sets allow_power_forms_admin_to_access_all_power_form_envelope_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_power_forms_admin_to_access_all_power_form_envelope_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_power_forms_admin_to_access_all_power_form_envelope_metadata allow_power_forms_admin_to_access_all_power_form_envelope_metadata + * * @return $this */ public function setAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata($allow_power_forms_admin_to_access_all_power_form_envelope_metadata) @@ -947,6 +1154,7 @@ public function setAllowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata($all /** * Gets allow_recipient_language_selection + * * @return string */ public function getAllowRecipientLanguageSelection() @@ -956,7 +1164,9 @@ public function getAllowRecipientLanguageSelection() /** * Sets allow_recipient_language_selection + * * @param string $allow_recipient_language_selection + * * @return $this */ public function setAllowRecipientLanguageSelection($allow_recipient_language_selection) @@ -968,6 +1178,7 @@ public function setAllowRecipientLanguageSelection($allow_recipient_language_sel /** * Gets allow_recipient_language_selection_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowRecipientLanguageSelectionMetadata() @@ -977,7 +1188,9 @@ public function getAllowRecipientLanguageSelectionMetadata() /** * Sets allow_recipient_language_selection_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_recipient_language_selection_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_recipient_language_selection_metadata allow_recipient_language_selection_metadata + * * @return $this */ public function setAllowRecipientLanguageSelectionMetadata($allow_recipient_language_selection_metadata) @@ -989,6 +1202,7 @@ public function setAllowRecipientLanguageSelectionMetadata($allow_recipient_lang /** * Gets allow_send_on_behalf_of + * * @return string */ public function getAllowSendOnBehalfOf() @@ -998,7 +1212,9 @@ public function getAllowSendOnBehalfOf() /** * Sets allow_send_on_behalf_of + * * @param string $allow_send_on_behalf_of + * * @return $this */ public function setAllowSendOnBehalfOf($allow_send_on_behalf_of) @@ -1010,6 +1226,7 @@ public function setAllowSendOnBehalfOf($allow_send_on_behalf_of) /** * Gets allow_send_on_behalf_of_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSendOnBehalfOfMetadata() @@ -1019,7 +1236,9 @@ public function getAllowSendOnBehalfOfMetadata() /** * Sets allow_send_on_behalf_of_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_send_on_behalf_of_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_send_on_behalf_of_metadata allow_send_on_behalf_of_metadata + * * @return $this */ public function setAllowSendOnBehalfOfMetadata($allow_send_on_behalf_of_metadata) @@ -1031,6 +1250,7 @@ public function setAllowSendOnBehalfOfMetadata($allow_send_on_behalf_of_metadata /** * Gets allow_supplemental_documents + * * @return string */ public function getAllowSupplementalDocuments() @@ -1040,7 +1260,9 @@ public function getAllowSupplementalDocuments() /** * Sets allow_supplemental_documents + * * @param string $allow_supplemental_documents + * * @return $this */ public function setAllowSupplementalDocuments($allow_supplemental_documents) @@ -1052,6 +1274,7 @@ public function setAllowSupplementalDocuments($allow_supplemental_documents) /** * Gets allow_supplemental_documents_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSupplementalDocumentsMetadata() @@ -1061,7 +1284,9 @@ public function getAllowSupplementalDocumentsMetadata() /** * Sets allow_supplemental_documents_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $allow_supplemental_documents_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_supplemental_documents_metadata allow_supplemental_documents_metadata + * * @return $this */ public function setAllowSupplementalDocumentsMetadata($allow_supplemental_documents_metadata) @@ -1073,6 +1298,7 @@ public function setAllowSupplementalDocumentsMetadata($allow_supplemental_docume /** * Gets anchor_tag_versioned_placement_enabled + * * @return string */ public function getAnchorTagVersionedPlacementEnabled() @@ -1082,7 +1308,9 @@ public function getAnchorTagVersionedPlacementEnabled() /** * Sets anchor_tag_versioned_placement_enabled + * * @param string $anchor_tag_versioned_placement_enabled + * * @return $this */ public function setAnchorTagVersionedPlacementEnabled($anchor_tag_versioned_placement_enabled) @@ -1094,6 +1322,7 @@ public function setAnchorTagVersionedPlacementEnabled($anchor_tag_versioned_plac /** * Gets api_account_wide_access + * * @return string */ public function getApiAccountWideAccess() @@ -1103,7 +1332,9 @@ public function getApiAccountWideAccess() /** * Sets api_account_wide_access + * * @param string $api_account_wide_access + * * @return $this */ public function setApiAccountWideAccess($api_account_wide_access) @@ -1115,6 +1346,7 @@ public function setApiAccountWideAccess($api_account_wide_access) /** * Gets api_account_wide_access_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getApiAccountWideAccessMetadata() @@ -1124,7 +1356,9 @@ public function getApiAccountWideAccessMetadata() /** * Sets api_account_wide_access_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $api_account_wide_access_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $api_account_wide_access_metadata api_account_wide_access_metadata + * * @return $this */ public function setApiAccountWideAccessMetadata($api_account_wide_access_metadata) @@ -1136,6 +1370,7 @@ public function setApiAccountWideAccessMetadata($api_account_wide_access_metadat /** * Gets api_can_export_ac + * * @return string */ public function getApiCanExportAc() @@ -1145,7 +1380,9 @@ public function getApiCanExportAc() /** * Sets api_can_export_ac + * * @param string $api_can_export_ac + * * @return $this */ public function setApiCanExportAc($api_can_export_ac) @@ -1157,6 +1394,7 @@ public function setApiCanExportAc($api_can_export_ac) /** * Gets api_can_export_ac_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getApiCanExportAcMetadata() @@ -1166,7 +1404,9 @@ public function getApiCanExportAcMetadata() /** * Sets api_can_export_ac_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $api_can_export_ac_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $api_can_export_ac_metadata api_can_export_ac_metadata + * * @return $this */ public function setApiCanExportAcMetadata($api_can_export_ac_metadata) @@ -1178,6 +1418,7 @@ public function setApiCanExportAcMetadata($api_can_export_ac_metadata) /** * Gets bulk_send + * * @return string */ public function getBulkSend() @@ -1187,7 +1428,9 @@ public function getBulkSend() /** * Sets bulk_send + * * @param string $bulk_send + * * @return $this */ public function setBulkSend($bulk_send) @@ -1199,6 +1442,7 @@ public function setBulkSend($bulk_send) /** * Gets bulk_send_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getBulkSendMetadata() @@ -1208,7 +1452,9 @@ public function getBulkSendMetadata() /** * Sets bulk_send_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $bulk_send_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $bulk_send_metadata bulk_send_metadata + * * @return $this */ public function setBulkSendMetadata($bulk_send_metadata) @@ -1220,6 +1466,7 @@ public function setBulkSendMetadata($bulk_send_metadata) /** * Gets can_charge_account + * * @return string */ public function getCanChargeAccount() @@ -1229,7 +1476,9 @@ public function getCanChargeAccount() /** * Sets can_charge_account + * * @param string $can_charge_account + * * @return $this */ public function setCanChargeAccount($can_charge_account) @@ -1241,6 +1490,7 @@ public function setCanChargeAccount($can_charge_account) /** * Gets can_charge_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanChargeAccountMetadata() @@ -1250,7 +1500,9 @@ public function getCanChargeAccountMetadata() /** * Sets can_charge_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_charge_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_charge_account_metadata can_charge_account_metadata + * * @return $this */ public function setCanChargeAccountMetadata($can_charge_account_metadata) @@ -1262,6 +1514,7 @@ public function setCanChargeAccountMetadata($can_charge_account_metadata) /** * Gets can_edit_shared_addressbook + * * @return string */ public function getCanEditSharedAddressbook() @@ -1271,7 +1524,9 @@ public function getCanEditSharedAddressbook() /** * Sets can_edit_shared_addressbook + * * @param string $can_edit_shared_addressbook + * * @return $this */ public function setCanEditSharedAddressbook($can_edit_shared_addressbook) @@ -1283,6 +1538,7 @@ public function setCanEditSharedAddressbook($can_edit_shared_addressbook) /** * Gets can_edit_shared_addressbook_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanEditSharedAddressbookMetadata() @@ -1292,7 +1548,9 @@ public function getCanEditSharedAddressbookMetadata() /** * Sets can_edit_shared_addressbook_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_edit_shared_addressbook_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_edit_shared_addressbook_metadata can_edit_shared_addressbook_metadata + * * @return $this */ public function setCanEditSharedAddressbookMetadata($can_edit_shared_addressbook_metadata) @@ -1304,6 +1562,7 @@ public function setCanEditSharedAddressbookMetadata($can_edit_shared_addressbook /** * Gets can_lock_envelopes + * * @return string */ public function getCanLockEnvelopes() @@ -1313,7 +1572,9 @@ public function getCanLockEnvelopes() /** * Sets can_lock_envelopes + * * @param string $can_lock_envelopes + * * @return $this */ public function setCanLockEnvelopes($can_lock_envelopes) @@ -1325,6 +1586,7 @@ public function setCanLockEnvelopes($can_lock_envelopes) /** * Gets can_lock_envelopes_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanLockEnvelopesMetadata() @@ -1334,7 +1596,9 @@ public function getCanLockEnvelopesMetadata() /** * Sets can_lock_envelopes_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_lock_envelopes_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_lock_envelopes_metadata can_lock_envelopes_metadata + * * @return $this */ public function setCanLockEnvelopesMetadata($can_lock_envelopes_metadata) @@ -1346,6 +1610,7 @@ public function setCanLockEnvelopesMetadata($can_lock_envelopes_metadata) /** * Gets can_manage_account + * * @return string */ public function getCanManageAccount() @@ -1355,7 +1620,9 @@ public function getCanManageAccount() /** * Sets can_manage_account + * * @param string $can_manage_account + * * @return $this */ public function setCanManageAccount($can_manage_account) @@ -1367,6 +1634,7 @@ public function setCanManageAccount($can_manage_account) /** * Gets can_manage_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageAccountMetadata() @@ -1376,7 +1644,9 @@ public function getCanManageAccountMetadata() /** * Sets can_manage_account_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_account_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_account_metadata can_manage_account_metadata + * * @return $this */ public function setCanManageAccountMetadata($can_manage_account_metadata) @@ -1388,6 +1658,7 @@ public function setCanManageAccountMetadata($can_manage_account_metadata) /** * Gets can_manage_distributor + * * @return string */ public function getCanManageDistributor() @@ -1397,7 +1668,9 @@ public function getCanManageDistributor() /** * Sets can_manage_distributor + * * @param string $can_manage_distributor + * * @return $this */ public function setCanManageDistributor($can_manage_distributor) @@ -1409,6 +1682,7 @@ public function setCanManageDistributor($can_manage_distributor) /** * Gets can_manage_distributor_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageDistributorMetadata() @@ -1418,7 +1692,9 @@ public function getCanManageDistributorMetadata() /** * Sets can_manage_distributor_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_distributor_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_distributor_metadata can_manage_distributor_metadata + * * @return $this */ public function setCanManageDistributorMetadata($can_manage_distributor_metadata) @@ -1430,6 +1706,7 @@ public function setCanManageDistributorMetadata($can_manage_distributor_metadata /** * Gets can_manage_templates + * * @return string */ public function getCanManageTemplates() @@ -1439,7 +1716,9 @@ public function getCanManageTemplates() /** * Sets can_manage_templates + * * @param string $can_manage_templates + * * @return $this */ public function setCanManageTemplates($can_manage_templates) @@ -1451,6 +1730,7 @@ public function setCanManageTemplates($can_manage_templates) /** * Gets can_manage_templates_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageTemplatesMetadata() @@ -1460,7 +1740,9 @@ public function getCanManageTemplatesMetadata() /** * Sets can_manage_templates_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_templates_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_templates_metadata can_manage_templates_metadata + * * @return $this */ public function setCanManageTemplatesMetadata($can_manage_templates_metadata) @@ -1472,6 +1754,7 @@ public function setCanManageTemplatesMetadata($can_manage_templates_metadata) /** * Gets can_send_api_requests + * * @return string */ public function getCanSendApiRequests() @@ -1481,7 +1764,9 @@ public function getCanSendApiRequests() /** * Sets can_send_api_requests + * * @param string $can_send_api_requests + * * @return $this */ public function setCanSendApiRequests($can_send_api_requests) @@ -1493,6 +1778,7 @@ public function setCanSendApiRequests($can_send_api_requests) /** * Gets can_send_api_requests_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanSendApiRequestsMetadata() @@ -1502,7 +1788,9 @@ public function getCanSendApiRequestsMetadata() /** * Sets can_send_api_requests_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_send_api_requests_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_send_api_requests_metadata can_send_api_requests_metadata + * * @return $this */ public function setCanSendApiRequestsMetadata($can_send_api_requests_metadata) @@ -1514,6 +1802,7 @@ public function setCanSendApiRequestsMetadata($can_send_api_requests_metadata) /** * Gets can_send_envelope + * * @return string */ public function getCanSendEnvelope() @@ -1523,7 +1812,9 @@ public function getCanSendEnvelope() /** * Sets can_send_envelope + * * @param string $can_send_envelope + * * @return $this */ public function setCanSendEnvelope($can_send_envelope) @@ -1535,6 +1826,7 @@ public function setCanSendEnvelope($can_send_envelope) /** * Gets can_send_envelope_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanSendEnvelopeMetadata() @@ -1544,7 +1836,9 @@ public function getCanSendEnvelopeMetadata() /** * Sets can_send_envelope_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_send_envelope_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_send_envelope_metadata can_send_envelope_metadata + * * @return $this */ public function setCanSendEnvelopeMetadata($can_send_envelope_metadata) @@ -1556,6 +1850,7 @@ public function setCanSendEnvelopeMetadata($can_send_envelope_metadata) /** * Gets can_sign_envelope + * * @return string */ public function getCanSignEnvelope() @@ -1565,7 +1860,9 @@ public function getCanSignEnvelope() /** * Sets can_sign_envelope + * * @param string $can_sign_envelope + * * @return $this */ public function setCanSignEnvelope($can_sign_envelope) @@ -1577,6 +1874,7 @@ public function setCanSignEnvelope($can_sign_envelope) /** * Gets can_sign_envelope_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanSignEnvelopeMetadata() @@ -1586,7 +1884,9 @@ public function getCanSignEnvelopeMetadata() /** * Sets can_sign_envelope_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_sign_envelope_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_sign_envelope_metadata can_sign_envelope_metadata + * * @return $this */ public function setCanSignEnvelopeMetadata($can_sign_envelope_metadata) @@ -1598,6 +1898,7 @@ public function setCanSignEnvelopeMetadata($can_sign_envelope_metadata) /** * Gets can_use_scratchpad + * * @return string */ public function getCanUseScratchpad() @@ -1607,7 +1908,9 @@ public function getCanUseScratchpad() /** * Sets can_use_scratchpad + * * @param string $can_use_scratchpad + * * @return $this */ public function setCanUseScratchpad($can_use_scratchpad) @@ -1619,6 +1922,7 @@ public function setCanUseScratchpad($can_use_scratchpad) /** * Gets can_use_scratchpad_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanUseScratchpadMetadata() @@ -1628,7 +1932,9 @@ public function getCanUseScratchpadMetadata() /** * Sets can_use_scratchpad_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_use_scratchpad_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_use_scratchpad_metadata can_use_scratchpad_metadata + * * @return $this */ public function setCanUseScratchpadMetadata($can_use_scratchpad_metadata) @@ -1640,6 +1946,7 @@ public function setCanUseScratchpadMetadata($can_use_scratchpad_metadata) /** * Gets can_use_smart_contracts + * * @return string */ public function getCanUseSmartContracts() @@ -1649,7 +1956,9 @@ public function getCanUseSmartContracts() /** * Sets can_use_smart_contracts + * * @param string $can_use_smart_contracts + * * @return $this */ public function setCanUseSmartContracts($can_use_smart_contracts) @@ -1661,6 +1970,7 @@ public function setCanUseSmartContracts($can_use_smart_contracts) /** * Gets can_use_smart_contracts_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanUseSmartContractsMetadata() @@ -1670,7 +1980,9 @@ public function getCanUseSmartContractsMetadata() /** * Sets can_use_smart_contracts_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_use_smart_contracts_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_use_smart_contracts_metadata can_use_smart_contracts_metadata + * * @return $this */ public function setCanUseSmartContractsMetadata($can_use_smart_contracts_metadata) @@ -1682,6 +1994,7 @@ public function setCanUseSmartContractsMetadata($can_use_smart_contracts_metadat /** * Gets disable_document_upload + * * @return string */ public function getDisableDocumentUpload() @@ -1691,7 +2004,9 @@ public function getDisableDocumentUpload() /** * Sets disable_document_upload + * * @param string $disable_document_upload + * * @return $this */ public function setDisableDocumentUpload($disable_document_upload) @@ -1703,6 +2018,7 @@ public function setDisableDocumentUpload($disable_document_upload) /** * Gets disable_document_upload_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableDocumentUploadMetadata() @@ -1712,7 +2028,9 @@ public function getDisableDocumentUploadMetadata() /** * Sets disable_document_upload_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_document_upload_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_document_upload_metadata disable_document_upload_metadata + * * @return $this */ public function setDisableDocumentUploadMetadata($disable_document_upload_metadata) @@ -1724,6 +2042,7 @@ public function setDisableDocumentUploadMetadata($disable_document_upload_metada /** * Gets disable_other_actions + * * @return string */ public function getDisableOtherActions() @@ -1733,7 +2052,9 @@ public function getDisableOtherActions() /** * Sets disable_other_actions + * * @param string $disable_other_actions + * * @return $this */ public function setDisableOtherActions($disable_other_actions) @@ -1745,6 +2066,7 @@ public function setDisableOtherActions($disable_other_actions) /** * Gets disable_other_actions_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableOtherActionsMetadata() @@ -1754,7 +2076,9 @@ public function getDisableOtherActionsMetadata() /** * Sets disable_other_actions_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $disable_other_actions_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $disable_other_actions_metadata disable_other_actions_metadata + * * @return $this */ public function setDisableOtherActionsMetadata($disable_other_actions_metadata) @@ -1766,6 +2090,7 @@ public function setDisableOtherActionsMetadata($disable_other_actions_metadata) /** * Gets enable_ds_pro + * * @return string */ public function getEnableDsPro() @@ -1775,7 +2100,9 @@ public function getEnableDsPro() /** * Sets enable_ds_pro + * * @param string $enable_ds_pro + * * @return $this */ public function setEnableDsPro($enable_ds_pro) @@ -1787,6 +2114,7 @@ public function setEnableDsPro($enable_ds_pro) /** * Gets enable_ds_pro_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableDsProMetadata() @@ -1796,7 +2124,9 @@ public function getEnableDsProMetadata() /** * Sets enable_ds_pro_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_ds_pro_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_ds_pro_metadata enable_ds_pro_metadata + * * @return $this */ public function setEnableDsProMetadata($enable_ds_pro_metadata) @@ -1808,6 +2138,7 @@ public function setEnableDsProMetadata($enable_ds_pro_metadata) /** * Gets enable_sequential_signing_api + * * @return string */ public function getEnableSequentialSigningApi() @@ -1817,7 +2148,9 @@ public function getEnableSequentialSigningApi() /** * Sets enable_sequential_signing_api + * * @param string $enable_sequential_signing_api + * * @return $this */ public function setEnableSequentialSigningApi($enable_sequential_signing_api) @@ -1829,6 +2162,7 @@ public function setEnableSequentialSigningApi($enable_sequential_signing_api) /** * Gets enable_sequential_signing_api_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSequentialSigningApiMetadata() @@ -1838,7 +2172,9 @@ public function getEnableSequentialSigningApiMetadata() /** * Sets enable_sequential_signing_api_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_api_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_api_metadata enable_sequential_signing_api_metadata + * * @return $this */ public function setEnableSequentialSigningApiMetadata($enable_sequential_signing_api_metadata) @@ -1850,6 +2186,7 @@ public function setEnableSequentialSigningApiMetadata($enable_sequential_signing /** * Gets enable_sequential_signing_ui + * * @return string */ public function getEnableSequentialSigningUi() @@ -1859,7 +2196,9 @@ public function getEnableSequentialSigningUi() /** * Sets enable_sequential_signing_ui + * * @param string $enable_sequential_signing_ui + * * @return $this */ public function setEnableSequentialSigningUi($enable_sequential_signing_ui) @@ -1871,6 +2210,7 @@ public function setEnableSequentialSigningUi($enable_sequential_signing_ui) /** * Gets enable_sequential_signing_ui_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSequentialSigningUiMetadata() @@ -1880,7 +2220,9 @@ public function getEnableSequentialSigningUiMetadata() /** * Sets enable_sequential_signing_ui_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_ui_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sequential_signing_ui_metadata enable_sequential_signing_ui_metadata + * * @return $this */ public function setEnableSequentialSigningUiMetadata($enable_sequential_signing_ui_metadata) @@ -1892,6 +2234,7 @@ public function setEnableSequentialSigningUiMetadata($enable_sequential_signing_ /** * Gets enable_signer_attachments + * * @return string */ public function getEnableSignerAttachments() @@ -1901,7 +2244,9 @@ public function getEnableSignerAttachments() /** * Sets enable_signer_attachments + * * @param string $enable_signer_attachments + * * @return $this */ public function setEnableSignerAttachments($enable_signer_attachments) @@ -1913,6 +2258,7 @@ public function setEnableSignerAttachments($enable_signer_attachments) /** * Gets enable_signer_attachments_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSignerAttachmentsMetadata() @@ -1922,7 +2268,9 @@ public function getEnableSignerAttachmentsMetadata() /** * Sets enable_signer_attachments_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signer_attachments_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_signer_attachments_metadata enable_signer_attachments_metadata + * * @return $this */ public function setEnableSignerAttachmentsMetadata($enable_signer_attachments_metadata) @@ -1934,6 +2282,7 @@ public function setEnableSignerAttachmentsMetadata($enable_signer_attachments_me /** * Gets enable_sign_on_paper_override + * * @return string */ public function getEnableSignOnPaperOverride() @@ -1943,7 +2292,9 @@ public function getEnableSignOnPaperOverride() /** * Sets enable_sign_on_paper_override + * * @param string $enable_sign_on_paper_override + * * @return $this */ public function setEnableSignOnPaperOverride($enable_sign_on_paper_override) @@ -1955,6 +2306,7 @@ public function setEnableSignOnPaperOverride($enable_sign_on_paper_override) /** * Gets enable_sign_on_paper_override_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSignOnPaperOverrideMetadata() @@ -1964,7 +2316,9 @@ public function getEnableSignOnPaperOverrideMetadata() /** * Sets enable_sign_on_paper_override_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sign_on_paper_override_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_sign_on_paper_override_metadata enable_sign_on_paper_override_metadata + * * @return $this */ public function setEnableSignOnPaperOverrideMetadata($enable_sign_on_paper_override_metadata) @@ -1976,6 +2330,7 @@ public function setEnableSignOnPaperOverrideMetadata($enable_sign_on_paper_overr /** * Gets enable_transaction_point + * * @return string */ public function getEnableTransactionPoint() @@ -1985,7 +2340,9 @@ public function getEnableTransactionPoint() /** * Sets enable_transaction_point + * * @param string $enable_transaction_point + * * @return $this */ public function setEnableTransactionPoint($enable_transaction_point) @@ -1997,6 +2354,7 @@ public function setEnableTransactionPoint($enable_transaction_point) /** * Gets enable_transaction_point_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableTransactionPointMetadata() @@ -2006,7 +2364,9 @@ public function getEnableTransactionPointMetadata() /** * Sets enable_transaction_point_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_transaction_point_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_transaction_point_metadata enable_transaction_point_metadata + * * @return $this */ public function setEnableTransactionPointMetadata($enable_transaction_point_metadata) @@ -2018,6 +2378,7 @@ public function setEnableTransactionPointMetadata($enable_transaction_point_meta /** * Gets enable_vaulting + * * @return string */ public function getEnableVaulting() @@ -2027,7 +2388,9 @@ public function getEnableVaulting() /** * Sets enable_vaulting + * * @param string $enable_vaulting + * * @return $this */ public function setEnableVaulting($enable_vaulting) @@ -2039,6 +2402,7 @@ public function setEnableVaulting($enable_vaulting) /** * Gets enable_vaulting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableVaultingMetadata() @@ -2048,7 +2412,9 @@ public function getEnableVaultingMetadata() /** * Sets enable_vaulting_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $enable_vaulting_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $enable_vaulting_metadata enable_vaulting_metadata + * * @return $this */ public function setEnableVaultingMetadata($enable_vaulting_metadata) @@ -2060,6 +2426,7 @@ public function setEnableVaultingMetadata($enable_vaulting_metadata) /** * Gets express_send_only + * * @return string */ public function getExpressSendOnly() @@ -2069,7 +2436,9 @@ public function getExpressSendOnly() /** * Sets express_send_only + * * @param string $express_send_only + * * @return $this */ public function setExpressSendOnly($express_send_only) @@ -2081,6 +2450,7 @@ public function setExpressSendOnly($express_send_only) /** * Gets locale + * * @return string */ public function getLocale() @@ -2090,7 +2460,9 @@ public function getLocale() /** * Sets locale + * * @param string $locale + * * @return $this */ public function setLocale($locale) @@ -2102,6 +2474,7 @@ public function setLocale($locale) /** * Gets locale_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getLocaleMetadata() @@ -2111,7 +2484,9 @@ public function getLocaleMetadata() /** * Sets locale_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $locale_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $locale_metadata locale_metadata + * * @return $this */ public function setLocaleMetadata($locale_metadata) @@ -2123,6 +2498,7 @@ public function setLocaleMetadata($locale_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicy */ public function getLocalePolicy() @@ -2132,7 +2508,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicy $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicy $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -2144,6 +2522,7 @@ public function setLocalePolicy($locale_policy) /** * Gets manage_clickwraps_mode + * * @return string */ public function getManageClickwrapsMode() @@ -2153,7 +2532,9 @@ public function getManageClickwrapsMode() /** * Sets manage_clickwraps_mode + * * @param string $manage_clickwraps_mode + * * @return $this */ public function setManageClickwrapsMode($manage_clickwraps_mode) @@ -2165,6 +2546,7 @@ public function setManageClickwrapsMode($manage_clickwraps_mode) /** * Gets manage_clickwraps_mode_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getManageClickwrapsModeMetadata() @@ -2174,7 +2556,9 @@ public function getManageClickwrapsModeMetadata() /** * Sets manage_clickwraps_mode_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $manage_clickwraps_mode_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $manage_clickwraps_mode_metadata manage_clickwraps_mode_metadata + * * @return $this */ public function setManageClickwrapsModeMetadata($manage_clickwraps_mode_metadata) @@ -2186,6 +2570,7 @@ public function setManageClickwrapsModeMetadata($manage_clickwraps_mode_metadata /** * Gets modified_by + * * @return string */ public function getModifiedBy() @@ -2195,7 +2580,9 @@ public function getModifiedBy() /** * Sets modified_by + * * @param string $modified_by + * * @return $this */ public function setModifiedBy($modified_by) @@ -2207,6 +2594,7 @@ public function setModifiedBy($modified_by) /** * Gets modified_by_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getModifiedByMetadata() @@ -2216,7 +2604,9 @@ public function getModifiedByMetadata() /** * Sets modified_by_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $modified_by_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $modified_by_metadata modified_by_metadata + * * @return $this */ public function setModifiedByMetadata($modified_by_metadata) @@ -2228,6 +2618,7 @@ public function setModifiedByMetadata($modified_by_metadata) /** * Gets modified_date + * * @return string */ public function getModifiedDate() @@ -2237,7 +2628,9 @@ public function getModifiedDate() /** * Sets modified_date + * * @param string $modified_date + * * @return $this */ public function setModifiedDate($modified_date) @@ -2249,6 +2642,7 @@ public function setModifiedDate($modified_date) /** * Gets modified_date_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getModifiedDateMetadata() @@ -2258,7 +2652,9 @@ public function getModifiedDateMetadata() /** * Sets modified_date_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $modified_date_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $modified_date_metadata modified_date_metadata + * * @return $this */ public function setModifiedDateMetadata($modified_date_metadata) @@ -2270,6 +2666,7 @@ public function setModifiedDateMetadata($modified_date_metadata) /** * Gets modified_page + * * @return string */ public function getModifiedPage() @@ -2279,7 +2676,9 @@ public function getModifiedPage() /** * Sets modified_page + * * @param string $modified_page + * * @return $this */ public function setModifiedPage($modified_page) @@ -2291,6 +2690,7 @@ public function setModifiedPage($modified_page) /** * Gets modified_page_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getModifiedPageMetadata() @@ -2300,7 +2700,9 @@ public function getModifiedPageMetadata() /** * Sets modified_page_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $modified_page_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $modified_page_metadata modified_page_metadata + * * @return $this */ public function setModifiedPageMetadata($modified_page_metadata) @@ -2312,6 +2714,7 @@ public function setModifiedPageMetadata($modified_page_metadata) /** * Gets new_send_ui + * * @return string */ public function getNewSendUi() @@ -2321,7 +2724,9 @@ public function getNewSendUi() /** * Sets new_send_ui + * * @param string $new_send_ui + * * @return $this */ public function setNewSendUi($new_send_ui) @@ -2333,6 +2738,7 @@ public function setNewSendUi($new_send_ui) /** * Gets new_send_ui_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getNewSendUiMetadata() @@ -2342,7 +2748,9 @@ public function getNewSendUiMetadata() /** * Sets new_send_ui_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $new_send_ui_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $new_send_ui_metadata new_send_ui_metadata + * * @return $this */ public function setNewSendUiMetadata($new_send_ui_metadata) @@ -2354,6 +2762,7 @@ public function setNewSendUiMetadata($new_send_ui_metadata) /** * Gets power_form_mode + * * @return string */ public function getPowerFormMode() @@ -2363,7 +2772,9 @@ public function getPowerFormMode() /** * Sets power_form_mode + * * @param string $power_form_mode + * * @return $this */ public function setPowerFormMode($power_form_mode) @@ -2375,6 +2786,7 @@ public function setPowerFormMode($power_form_mode) /** * Gets power_form_mode_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getPowerFormModeMetadata() @@ -2384,7 +2796,9 @@ public function getPowerFormModeMetadata() /** * Sets power_form_mode_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $power_form_mode_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $power_form_mode_metadata power_form_mode_metadata + * * @return $this */ public function setPowerFormModeMetadata($power_form_mode_metadata) @@ -2396,6 +2810,7 @@ public function setPowerFormModeMetadata($power_form_mode_metadata) /** * Gets recipient_viewed_notification + * * @return string */ public function getRecipientViewedNotification() @@ -2405,7 +2820,9 @@ public function getRecipientViewedNotification() /** * Sets recipient_viewed_notification + * * @param string $recipient_viewed_notification + * * @return $this */ public function setRecipientViewedNotification($recipient_viewed_notification) @@ -2417,6 +2834,7 @@ public function setRecipientViewedNotification($recipient_viewed_notification) /** * Gets recipient_viewed_notification_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRecipientViewedNotificationMetadata() @@ -2426,7 +2844,9 @@ public function getRecipientViewedNotificationMetadata() /** * Sets recipient_viewed_notification_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $recipient_viewed_notification_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $recipient_viewed_notification_metadata recipient_viewed_notification_metadata + * * @return $this */ public function setRecipientViewedNotificationMetadata($recipient_viewed_notification_metadata) @@ -2438,6 +2858,7 @@ public function setRecipientViewedNotificationMetadata($recipient_viewed_notific /** * Gets seal_identifiers + * * @return \DocuSign\eSign\Model\SealIdentifier[] */ public function getSealIdentifiers() @@ -2447,7 +2868,9 @@ public function getSealIdentifiers() /** * Sets seal_identifiers + * * @param \DocuSign\eSign\Model\SealIdentifier[] $seal_identifiers + * * @return $this */ public function setSealIdentifiers($seal_identifiers) @@ -2459,6 +2882,7 @@ public function setSealIdentifiers($seal_identifiers) /** * Gets self_signed_recipient_email_document + * * @return string */ public function getSelfSignedRecipientEmailDocument() @@ -2468,7 +2892,9 @@ public function getSelfSignedRecipientEmailDocument() /** * Sets self_signed_recipient_email_document + * * @param string $self_signed_recipient_email_document + * * @return $this */ public function setSelfSignedRecipientEmailDocument($self_signed_recipient_email_document) @@ -2480,6 +2906,7 @@ public function setSelfSignedRecipientEmailDocument($self_signed_recipient_email /** * Gets self_signed_recipient_email_document_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSelfSignedRecipientEmailDocumentMetadata() @@ -2489,7 +2916,9 @@ public function getSelfSignedRecipientEmailDocumentMetadata() /** * Sets self_signed_recipient_email_document_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $self_signed_recipient_email_document_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $self_signed_recipient_email_document_metadata self_signed_recipient_email_document_metadata + * * @return $this */ public function setSelfSignedRecipientEmailDocumentMetadata($self_signed_recipient_email_document_metadata) @@ -2501,6 +2930,7 @@ public function setSelfSignedRecipientEmailDocumentMetadata($self_signed_recipie /** * Gets sender_email_notifications + * * @return \DocuSign\eSign\Model\SenderEmailNotifications */ public function getSenderEmailNotifications() @@ -2510,7 +2940,9 @@ public function getSenderEmailNotifications() /** * Sets sender_email_notifications - * @param \DocuSign\eSign\Model\SenderEmailNotifications $sender_email_notifications + * + * @param \DocuSign\eSign\Model\SenderEmailNotifications $sender_email_notifications sender_email_notifications + * * @return $this */ public function setSenderEmailNotifications($sender_email_notifications) @@ -2522,6 +2954,7 @@ public function setSenderEmailNotifications($sender_email_notifications) /** * Gets signer_email_notifications + * * @return \DocuSign\eSign\Model\SignerEmailNotifications */ public function getSignerEmailNotifications() @@ -2531,7 +2964,9 @@ public function getSignerEmailNotifications() /** * Sets signer_email_notifications - * @param \DocuSign\eSign\Model\SignerEmailNotifications $signer_email_notifications + * + * @param \DocuSign\eSign\Model\SignerEmailNotifications $signer_email_notifications signer_email_notifications + * * @return $this */ public function setSignerEmailNotifications($signer_email_notifications) @@ -2543,6 +2978,7 @@ public function setSignerEmailNotifications($signer_email_notifications) /** * Gets supplemental_document_include_in_download + * * @return string */ public function getSupplementalDocumentIncludeInDownload() @@ -2552,7 +2988,9 @@ public function getSupplementalDocumentIncludeInDownload() /** * Sets supplemental_document_include_in_download + * * @param string $supplemental_document_include_in_download + * * @return $this */ public function setSupplementalDocumentIncludeInDownload($supplemental_document_include_in_download) @@ -2564,6 +3002,7 @@ public function setSupplementalDocumentIncludeInDownload($supplemental_document_ /** * Gets supplemental_documents_must_accept + * * @return string */ public function getSupplementalDocumentsMustAccept() @@ -2573,7 +3012,9 @@ public function getSupplementalDocumentsMustAccept() /** * Sets supplemental_documents_must_accept + * * @param string $supplemental_documents_must_accept + * * @return $this */ public function setSupplementalDocumentsMustAccept($supplemental_documents_must_accept) @@ -2585,6 +3026,7 @@ public function setSupplementalDocumentsMustAccept($supplemental_documents_must_ /** * Gets supplemental_documents_must_accept_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustAcceptMetadata() @@ -2594,7 +3036,9 @@ public function getSupplementalDocumentsMustAcceptMetadata() /** * Sets supplemental_documents_must_accept_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_accept_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_accept_metadata supplemental_documents_must_accept_metadata + * * @return $this */ public function setSupplementalDocumentsMustAcceptMetadata($supplemental_documents_must_accept_metadata) @@ -2606,6 +3050,7 @@ public function setSupplementalDocumentsMustAcceptMetadata($supplemental_documen /** * Gets supplemental_documents_must_read + * * @return string */ public function getSupplementalDocumentsMustRead() @@ -2615,7 +3060,9 @@ public function getSupplementalDocumentsMustRead() /** * Sets supplemental_documents_must_read + * * @param string $supplemental_documents_must_read + * * @return $this */ public function setSupplementalDocumentsMustRead($supplemental_documents_must_read) @@ -2627,6 +3074,7 @@ public function setSupplementalDocumentsMustRead($supplemental_documents_must_re /** * Gets supplemental_documents_must_read_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustReadMetadata() @@ -2636,7 +3084,9 @@ public function getSupplementalDocumentsMustReadMetadata() /** * Sets supplemental_documents_must_read_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_read_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_read_metadata supplemental_documents_must_read_metadata + * * @return $this */ public function setSupplementalDocumentsMustReadMetadata($supplemental_documents_must_read_metadata) @@ -2648,6 +3098,7 @@ public function setSupplementalDocumentsMustReadMetadata($supplemental_documents /** * Gets supplemental_documents_must_view + * * @return string */ public function getSupplementalDocumentsMustView() @@ -2657,7 +3108,9 @@ public function getSupplementalDocumentsMustView() /** * Sets supplemental_documents_must_view + * * @param string $supplemental_documents_must_view + * * @return $this */ public function setSupplementalDocumentsMustView($supplemental_documents_must_view) @@ -2669,6 +3122,7 @@ public function setSupplementalDocumentsMustView($supplemental_documents_must_vi /** * Gets supplemental_documents_must_view_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustViewMetadata() @@ -2678,7 +3132,9 @@ public function getSupplementalDocumentsMustViewMetadata() /** * Sets supplemental_documents_must_view_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_view_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $supplemental_documents_must_view_metadata supplemental_documents_must_view_metadata + * * @return $this */ public function setSupplementalDocumentsMustViewMetadata($supplemental_documents_must_view_metadata) @@ -2690,6 +3146,7 @@ public function setSupplementalDocumentsMustViewMetadata($supplemental_documents /** * Gets template_active_creation + * * @return string */ public function getTemplateActiveCreation() @@ -2699,7 +3156,9 @@ public function getTemplateActiveCreation() /** * Sets template_active_creation + * * @param string $template_active_creation + * * @return $this */ public function setTemplateActiveCreation($template_active_creation) @@ -2711,6 +3170,7 @@ public function setTemplateActiveCreation($template_active_creation) /** * Gets template_active_creation_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTemplateActiveCreationMetadata() @@ -2720,7 +3180,9 @@ public function getTemplateActiveCreationMetadata() /** * Sets template_active_creation_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $template_active_creation_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $template_active_creation_metadata template_active_creation_metadata + * * @return $this */ public function setTemplateActiveCreationMetadata($template_active_creation_metadata) @@ -2732,6 +3194,7 @@ public function setTemplateActiveCreationMetadata($template_active_creation_meta /** * Gets template_apply_notify + * * @return string */ public function getTemplateApplyNotify() @@ -2741,7 +3204,9 @@ public function getTemplateApplyNotify() /** * Sets template_apply_notify + * * @param string $template_apply_notify + * * @return $this */ public function setTemplateApplyNotify($template_apply_notify) @@ -2753,6 +3218,7 @@ public function setTemplateApplyNotify($template_apply_notify) /** * Gets template_apply_notify_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTemplateApplyNotifyMetadata() @@ -2762,7 +3228,9 @@ public function getTemplateApplyNotifyMetadata() /** * Sets template_apply_notify_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $template_apply_notify_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $template_apply_notify_metadata template_apply_notify_metadata + * * @return $this */ public function setTemplateApplyNotifyMetadata($template_apply_notify_metadata) @@ -2774,6 +3242,7 @@ public function setTemplateApplyNotifyMetadata($template_apply_notify_metadata) /** * Gets template_auto_matching + * * @return string */ public function getTemplateAutoMatching() @@ -2783,7 +3252,9 @@ public function getTemplateAutoMatching() /** * Sets template_auto_matching + * * @param string $template_auto_matching + * * @return $this */ public function setTemplateAutoMatching($template_auto_matching) @@ -2795,6 +3266,7 @@ public function setTemplateAutoMatching($template_auto_matching) /** * Gets template_auto_matching_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTemplateAutoMatchingMetadata() @@ -2804,7 +3276,9 @@ public function getTemplateAutoMatchingMetadata() /** * Sets template_auto_matching_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $template_auto_matching_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $template_auto_matching_metadata template_auto_matching_metadata + * * @return $this */ public function setTemplateAutoMatchingMetadata($template_auto_matching_metadata) @@ -2816,6 +3290,7 @@ public function setTemplateAutoMatchingMetadata($template_auto_matching_metadata /** * Gets template_matching_sensitivity + * * @return string */ public function getTemplateMatchingSensitivity() @@ -2825,7 +3300,9 @@ public function getTemplateMatchingSensitivity() /** * Sets template_matching_sensitivity + * * @param string $template_matching_sensitivity + * * @return $this */ public function setTemplateMatchingSensitivity($template_matching_sensitivity) @@ -2837,6 +3314,7 @@ public function setTemplateMatchingSensitivity($template_matching_sensitivity) /** * Gets template_matching_sensitivity_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTemplateMatchingSensitivityMetadata() @@ -2846,7 +3324,9 @@ public function getTemplateMatchingSensitivityMetadata() /** * Sets template_matching_sensitivity_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $template_matching_sensitivity_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $template_matching_sensitivity_metadata template_matching_sensitivity_metadata + * * @return $this */ public function setTemplateMatchingSensitivityMetadata($template_matching_sensitivity_metadata) @@ -2858,6 +3338,7 @@ public function setTemplateMatchingSensitivityMetadata($template_matching_sensit /** * Gets template_page_level_matching + * * @return string */ public function getTemplatePageLevelMatching() @@ -2867,7 +3348,9 @@ public function getTemplatePageLevelMatching() /** * Sets template_page_level_matching + * * @param string $template_page_level_matching + * * @return $this */ public function setTemplatePageLevelMatching($template_page_level_matching) @@ -2879,6 +3362,7 @@ public function setTemplatePageLevelMatching($template_page_level_matching) /** * Gets template_page_level_matching_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTemplatePageLevelMatchingMetadata() @@ -2888,7 +3372,9 @@ public function getTemplatePageLevelMatchingMetadata() /** * Sets template_page_level_matching_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $template_page_level_matching_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $template_page_level_matching_metadata template_page_level_matching_metadata + * * @return $this */ public function setTemplatePageLevelMatchingMetadata($template_page_level_matching_metadata) @@ -2900,6 +3386,7 @@ public function setTemplatePageLevelMatchingMetadata($template_page_level_matchi /** * Gets timezone_dst + * * @return string */ public function getTimezoneDst() @@ -2909,7 +3396,9 @@ public function getTimezoneDst() /** * Sets timezone_dst + * * @param string $timezone_dst + * * @return $this */ public function setTimezoneDst($timezone_dst) @@ -2921,6 +3410,7 @@ public function setTimezoneDst($timezone_dst) /** * Gets timezone_dst_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTimezoneDstMetadata() @@ -2930,7 +3420,9 @@ public function getTimezoneDstMetadata() /** * Sets timezone_dst_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_dst_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_dst_metadata timezone_dst_metadata + * * @return $this */ public function setTimezoneDstMetadata($timezone_dst_metadata) @@ -2942,6 +3434,7 @@ public function setTimezoneDstMetadata($timezone_dst_metadata) /** * Gets timezone_mask + * * @return string */ public function getTimezoneMask() @@ -2951,7 +3444,9 @@ public function getTimezoneMask() /** * Sets timezone_mask + * * @param string $timezone_mask + * * @return $this */ public function setTimezoneMask($timezone_mask) @@ -2963,6 +3458,7 @@ public function setTimezoneMask($timezone_mask) /** * Gets timezone_mask_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTimezoneMaskMetadata() @@ -2972,7 +3468,9 @@ public function getTimezoneMaskMetadata() /** * Sets timezone_mask_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_mask_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_mask_metadata timezone_mask_metadata + * * @return $this */ public function setTimezoneMaskMetadata($timezone_mask_metadata) @@ -2984,6 +3482,7 @@ public function setTimezoneMaskMetadata($timezone_mask_metadata) /** * Gets timezone_offset + * * @return string */ public function getTimezoneOffset() @@ -2993,7 +3492,9 @@ public function getTimezoneOffset() /** * Sets timezone_offset + * * @param string $timezone_offset + * * @return $this */ public function setTimezoneOffset($timezone_offset) @@ -3005,6 +3506,7 @@ public function setTimezoneOffset($timezone_offset) /** * Gets timezone_offset_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTimezoneOffsetMetadata() @@ -3014,7 +3516,9 @@ public function getTimezoneOffsetMetadata() /** * Sets timezone_offset_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_offset_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_offset_metadata timezone_offset_metadata + * * @return $this */ public function setTimezoneOffsetMetadata($timezone_offset_metadata) @@ -3026,6 +3530,7 @@ public function setTimezoneOffsetMetadata($timezone_offset_metadata) /** * Gets timezone_sending_pref + * * @return string */ public function getTimezoneSendingPref() @@ -3035,7 +3540,9 @@ public function getTimezoneSendingPref() /** * Sets timezone_sending_pref + * * @param string $timezone_sending_pref + * * @return $this */ public function setTimezoneSendingPref($timezone_sending_pref) @@ -3047,6 +3554,7 @@ public function setTimezoneSendingPref($timezone_sending_pref) /** * Gets timezone_sending_pref_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTimezoneSendingPrefMetadata() @@ -3056,7 +3564,9 @@ public function getTimezoneSendingPrefMetadata() /** * Sets timezone_sending_pref_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_sending_pref_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_sending_pref_metadata timezone_sending_pref_metadata + * * @return $this */ public function setTimezoneSendingPrefMetadata($timezone_sending_pref_metadata) @@ -3068,6 +3578,7 @@ public function setTimezoneSendingPrefMetadata($timezone_sending_pref_metadata) /** * Gets timezone_signing_pref + * * @return string */ public function getTimezoneSigningPref() @@ -3077,7 +3588,9 @@ public function getTimezoneSigningPref() /** * Sets timezone_signing_pref + * * @param string $timezone_signing_pref + * * @return $this */ public function setTimezoneSigningPref($timezone_signing_pref) @@ -3089,6 +3602,7 @@ public function setTimezoneSigningPref($timezone_signing_pref) /** * Gets timezone_signing_pref_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTimezoneSigningPrefMetadata() @@ -3098,7 +3612,9 @@ public function getTimezoneSigningPrefMetadata() /** * Sets timezone_signing_pref_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_signing_pref_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $timezone_signing_pref_metadata timezone_signing_pref_metadata + * * @return $this */ public function setTimezoneSigningPrefMetadata($timezone_signing_pref_metadata) @@ -3110,6 +3626,7 @@ public function setTimezoneSigningPrefMetadata($timezone_signing_pref_metadata) /** * Gets transaction_point_site_name_url + * * @return string */ public function getTransactionPointSiteNameUrl() @@ -3119,7 +3636,9 @@ public function getTransactionPointSiteNameUrl() /** * Sets transaction_point_site_name_url + * * @param string $transaction_point_site_name_url + * * @return $this */ public function setTransactionPointSiteNameUrl($transaction_point_site_name_url) @@ -3131,6 +3650,7 @@ public function setTransactionPointSiteNameUrl($transaction_point_site_name_url) /** * Gets transaction_point_site_name_url_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTransactionPointSiteNameUrlMetadata() @@ -3140,7 +3660,9 @@ public function getTransactionPointSiteNameUrlMetadata() /** * Sets transaction_point_site_name_url_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $transaction_point_site_name_url_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $transaction_point_site_name_url_metadata transaction_point_site_name_url_metadata + * * @return $this */ public function setTransactionPointSiteNameUrlMetadata($transaction_point_site_name_url_metadata) @@ -3152,6 +3674,7 @@ public function setTransactionPointSiteNameUrlMetadata($transaction_point_site_n /** * Gets transaction_point_user_name + * * @return string */ public function getTransactionPointUserName() @@ -3161,7 +3684,9 @@ public function getTransactionPointUserName() /** * Sets transaction_point_user_name + * * @param string $transaction_point_user_name + * * @return $this */ public function setTransactionPointUserName($transaction_point_user_name) @@ -3173,6 +3698,7 @@ public function setTransactionPointUserName($transaction_point_user_name) /** * Gets transaction_point_user_name_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTransactionPointUserNameMetadata() @@ -3182,7 +3708,9 @@ public function getTransactionPointUserNameMetadata() /** * Sets transaction_point_user_name_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $transaction_point_user_name_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $transaction_point_user_name_metadata transaction_point_user_name_metadata + * * @return $this */ public function setTransactionPointUserNameMetadata($transaction_point_user_name_metadata) @@ -3194,6 +3722,7 @@ public function setTransactionPointUserNameMetadata($transaction_point_user_name /** * Gets vaulting_mode + * * @return string */ public function getVaultingMode() @@ -3203,7 +3732,9 @@ public function getVaultingMode() /** * Sets vaulting_mode + * * @param string $vaulting_mode + * * @return $this */ public function setVaultingMode($vaulting_mode) @@ -3215,6 +3746,7 @@ public function setVaultingMode($vaulting_mode) /** * Gets vaulting_mode_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getVaultingModeMetadata() @@ -3224,7 +3756,9 @@ public function getVaultingModeMetadata() /** * Sets vaulting_mode_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $vaulting_mode_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $vaulting_mode_metadata vaulting_mode_metadata + * * @return $this */ public function setVaultingModeMetadata($vaulting_mode_metadata) @@ -3235,7 +3769,9 @@ public function setVaultingModeMetadata($vaulting_mode_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -3245,7 +3781,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -3255,8 +3793,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -3270,7 +3810,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -3280,16 +3822,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserSharedItem.php b/src/Model/UserSharedItem.php index adca4842..2bba0062 100644 --- a/src/Model/UserSharedItem.php +++ b/src/Model/UserSharedItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserSharedItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserSharedItem implements ArrayAccess +class UserSharedItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userSharedItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -59,13 +62,41 @@ class UserSharedItem implements ArrayAccess 'user' => '\DocuSign\eSign\Model\UserInfo' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'shared' => null, + 'user' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'user' => 'user' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'user' => 'setUser' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'user' => 'getUser' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -133,30 +193,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -166,7 +228,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -178,6 +242,7 @@ public function setErrorDetails($error_details) /** * Gets shared + * * @return string */ public function getShared() @@ -187,7 +252,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -199,6 +266,7 @@ public function setShared($shared) /** * Gets user + * * @return \DocuSign\eSign\Model\UserInfo */ public function getUser() @@ -208,7 +276,9 @@ public function getUser() /** * Sets user - * @param \DocuSign\eSign\Model\UserInfo $user + * + * @param \DocuSign\eSign\Model\UserInfo $user user + * * @return $this */ public function setUser($user) @@ -219,7 +289,9 @@ public function setUser($user) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -229,7 +301,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -239,8 +313,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -254,7 +330,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -264,16 +342,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserSignature.php b/src/Model/UserSignature.php index dbf07a81..c44443a2 100644 --- a/src/Model/UserSignature.php +++ b/src/Model/UserSignature.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserSignature Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserSignature implements ArrayAccess +class UserSignature implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userSignature'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -86,13 +89,68 @@ class UserSignature implements ArrayAccess 'status' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'adopted_date_time' => null, + 'created_date_time' => null, + 'custom_field' => null, + 'date_stamp_properties' => null, + 'disallow_user_resize_stamp' => null, + 'error_details' => null, + 'external_id' => null, + 'image_base64' => null, + 'image_type' => null, + 'initials150_image_id' => null, + 'initials_image_uri' => null, + 'is_default' => null, + 'last_modified_date_time' => null, + 'nrds_id' => null, + 'nrds_last_name' => null, + 'nrds_status' => null, + 'phonetic_name' => null, + 'signature150_image_id' => null, + 'signature_font' => null, + 'signature_id' => null, + 'signature_image_uri' => null, + 'signature_initials' => null, + 'signature_name' => null, + 'signature_rights' => null, + 'signature_type' => null, + 'stamp_format' => null, + 'stamp_image_uri' => null, + 'stamp_size_mm' => null, + 'stamp_type' => null, + 'status' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -128,9 +186,9 @@ public static function swaggerTypes() 'status' => 'status' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -166,9 +224,9 @@ public static function swaggerTypes() 'status' => 'setStatus' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -204,34 +262,63 @@ public static function swaggerTypes() 'status' => 'getStatus' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -268,30 +355,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets adopted_date_time + * * @return string */ public function getAdoptedDateTime() @@ -301,7 +390,9 @@ public function getAdoptedDateTime() /** * Sets adopted_date_time + * * @param string $adopted_date_time The date and time the user adopted their signature. + * * @return $this */ public function setAdoptedDateTime($adopted_date_time) @@ -313,6 +404,7 @@ public function setAdoptedDateTime($adopted_date_time) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -322,7 +414,9 @@ public function getCreatedDateTime() /** * Sets created_date_time + * * @param string $created_date_time Indicates the date and time the item was created. + * * @return $this */ public function setCreatedDateTime($created_date_time) @@ -334,6 +428,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_field + * * @return string */ public function getCustomField() @@ -343,7 +438,9 @@ public function getCustomField() /** * Sets custom_field + * * @param string $custom_field + * * @return $this */ public function setCustomField($custom_field) @@ -355,6 +452,7 @@ public function setCustomField($custom_field) /** * Gets date_stamp_properties + * * @return \DocuSign\eSign\Model\DateStampProperties */ public function getDateStampProperties() @@ -364,7 +462,9 @@ public function getDateStampProperties() /** * Sets date_stamp_properties - * @param \DocuSign\eSign\Model\DateStampProperties $date_stamp_properties + * + * @param \DocuSign\eSign\Model\DateStampProperties $date_stamp_properties date_stamp_properties + * * @return $this */ public function setDateStampProperties($date_stamp_properties) @@ -376,6 +476,7 @@ public function setDateStampProperties($date_stamp_properties) /** * Gets disallow_user_resize_stamp + * * @return string */ public function getDisallowUserResizeStamp() @@ -385,7 +486,9 @@ public function getDisallowUserResizeStamp() /** * Sets disallow_user_resize_stamp + * * @param string $disallow_user_resize_stamp + * * @return $this */ public function setDisallowUserResizeStamp($disallow_user_resize_stamp) @@ -397,6 +500,7 @@ public function setDisallowUserResizeStamp($disallow_user_resize_stamp) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -406,7 +510,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -418,6 +524,7 @@ public function setErrorDetails($error_details) /** * Gets external_id + * * @return string */ public function getExternalId() @@ -427,7 +534,9 @@ public function getExternalId() /** * Sets external_id + * * @param string $external_id + * * @return $this */ public function setExternalId($external_id) @@ -439,6 +548,7 @@ public function setExternalId($external_id) /** * Gets image_base64 + * * @return string */ public function getImageBase64() @@ -448,7 +558,9 @@ public function getImageBase64() /** * Sets image_base64 + * * @param string $image_base64 + * * @return $this */ public function setImageBase64($image_base64) @@ -460,6 +572,7 @@ public function setImageBase64($image_base64) /** * Gets image_type + * * @return string */ public function getImageType() @@ -469,7 +582,9 @@ public function getImageType() /** * Sets image_type + * * @param string $image_type + * * @return $this */ public function setImageType($image_type) @@ -481,6 +596,7 @@ public function setImageType($image_type) /** * Gets initials150_image_id + * * @return string */ public function getInitials150ImageId() @@ -490,7 +606,9 @@ public function getInitials150ImageId() /** * Sets initials150_image_id + * * @param string $initials150_image_id + * * @return $this */ public function setInitials150ImageId($initials150_image_id) @@ -502,6 +620,7 @@ public function setInitials150ImageId($initials150_image_id) /** * Gets initials_image_uri + * * @return string */ public function getInitialsImageUri() @@ -511,7 +630,9 @@ public function getInitialsImageUri() /** * Sets initials_image_uri + * * @param string $initials_image_uri Contains the URI for an endpoint that you can use to retrieve the initials image. + * * @return $this */ public function setInitialsImageUri($initials_image_uri) @@ -523,6 +644,7 @@ public function setInitialsImageUri($initials_image_uri) /** * Gets is_default + * * @return string */ public function getIsDefault() @@ -532,7 +654,9 @@ public function getIsDefault() /** * Sets is_default + * * @param string $is_default + * * @return $this */ public function setIsDefault($is_default) @@ -544,6 +668,7 @@ public function setIsDefault($is_default) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -553,7 +678,9 @@ public function getLastModifiedDateTime() /** * Sets last_modified_date_time + * * @param string $last_modified_date_time The date and time the item was last modified. + * * @return $this */ public function setLastModifiedDateTime($last_modified_date_time) @@ -565,6 +692,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets nrds_id + * * @return string */ public function getNrdsId() @@ -574,7 +702,9 @@ public function getNrdsId() /** * Sets nrds_id + * * @param string $nrds_id + * * @return $this */ public function setNrdsId($nrds_id) @@ -586,6 +716,7 @@ public function setNrdsId($nrds_id) /** * Gets nrds_last_name + * * @return string */ public function getNrdsLastName() @@ -595,7 +726,9 @@ public function getNrdsLastName() /** * Sets nrds_last_name + * * @param string $nrds_last_name + * * @return $this */ public function setNrdsLastName($nrds_last_name) @@ -607,6 +740,7 @@ public function setNrdsLastName($nrds_last_name) /** * Gets nrds_status + * * @return string */ public function getNrdsStatus() @@ -616,7 +750,9 @@ public function getNrdsStatus() /** * Sets nrds_status + * * @param string $nrds_status + * * @return $this */ public function setNrdsStatus($nrds_status) @@ -628,6 +764,7 @@ public function setNrdsStatus($nrds_status) /** * Gets phonetic_name + * * @return string */ public function getPhoneticName() @@ -637,7 +774,9 @@ public function getPhoneticName() /** * Sets phonetic_name + * * @param string $phonetic_name + * * @return $this */ public function setPhoneticName($phonetic_name) @@ -649,6 +788,7 @@ public function setPhoneticName($phonetic_name) /** * Gets signature150_image_id + * * @return string */ public function getSignature150ImageId() @@ -658,7 +798,9 @@ public function getSignature150ImageId() /** * Sets signature150_image_id + * * @param string $signature150_image_id + * * @return $this */ public function setSignature150ImageId($signature150_image_id) @@ -670,6 +812,7 @@ public function setSignature150ImageId($signature150_image_id) /** * Gets signature_font + * * @return string */ public function getSignatureFont() @@ -679,7 +822,9 @@ public function getSignatureFont() /** * Sets signature_font + * * @param string $signature_font The font type for the signature, if the signature is not drawn. The supported font types are: \"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\" + * * @return $this */ public function setSignatureFont($signature_font) @@ -691,6 +836,7 @@ public function setSignatureFont($signature_font) /** * Gets signature_id + * * @return string */ public function getSignatureId() @@ -700,7 +846,9 @@ public function getSignatureId() /** * Sets signature_id + * * @param string $signature_id Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. + * * @return $this */ public function setSignatureId($signature_id) @@ -712,6 +860,7 @@ public function setSignatureId($signature_id) /** * Gets signature_image_uri + * * @return string */ public function getSignatureImageUri() @@ -721,7 +870,9 @@ public function getSignatureImageUri() /** * Sets signature_image_uri + * * @param string $signature_image_uri Contains the URI for an endpoint that you can use to retrieve the signature image. + * * @return $this */ public function setSignatureImageUri($signature_image_uri) @@ -733,6 +884,7 @@ public function setSignatureImageUri($signature_image_uri) /** * Gets signature_initials + * * @return string */ public function getSignatureInitials() @@ -742,7 +894,9 @@ public function getSignatureInitials() /** * Sets signature_initials + * * @param string $signature_initials The initials associated with the signature. + * * @return $this */ public function setSignatureInitials($signature_initials) @@ -754,6 +908,7 @@ public function setSignatureInitials($signature_initials) /** * Gets signature_name + * * @return string */ public function getSignatureName() @@ -763,7 +918,9 @@ public function getSignatureName() /** * Sets signature_name + * * @param string $signature_name Specifies the user signature name. + * * @return $this */ public function setSignatureName($signature_name) @@ -775,6 +932,7 @@ public function setSignatureName($signature_name) /** * Gets signature_rights + * * @return string */ public function getSignatureRights() @@ -784,7 +942,9 @@ public function getSignatureRights() /** * Sets signature_rights + * * @param string $signature_rights + * * @return $this */ public function setSignatureRights($signature_rights) @@ -796,6 +956,7 @@ public function setSignatureRights($signature_rights) /** * Gets signature_type + * * @return string */ public function getSignatureType() @@ -805,7 +966,9 @@ public function getSignatureType() /** * Sets signature_type + * * @param string $signature_type + * * @return $this */ public function setSignatureType($signature_type) @@ -817,6 +980,7 @@ public function setSignatureType($signature_type) /** * Gets stamp_format + * * @return string */ public function getStampFormat() @@ -826,7 +990,9 @@ public function getStampFormat() /** * Sets stamp_format + * * @param string $stamp_format + * * @return $this */ public function setStampFormat($stamp_format) @@ -838,6 +1004,7 @@ public function setStampFormat($stamp_format) /** * Gets stamp_image_uri + * * @return string */ public function getStampImageUri() @@ -847,7 +1014,9 @@ public function getStampImageUri() /** * Sets stamp_image_uri + * * @param string $stamp_image_uri + * * @return $this */ public function setStampImageUri($stamp_image_uri) @@ -859,6 +1028,7 @@ public function setStampImageUri($stamp_image_uri) /** * Gets stamp_size_mm + * * @return string */ public function getStampSizeMm() @@ -868,7 +1038,9 @@ public function getStampSizeMm() /** * Sets stamp_size_mm + * * @param string $stamp_size_mm + * * @return $this */ public function setStampSizeMm($stamp_size_mm) @@ -880,6 +1052,7 @@ public function setStampSizeMm($stamp_size_mm) /** * Gets stamp_type + * * @return string */ public function getStampType() @@ -889,7 +1062,9 @@ public function getStampType() /** * Sets stamp_type + * * @param string $stamp_type + * * @return $this */ public function setStampType($stamp_type) @@ -901,6 +1076,7 @@ public function setStampType($stamp_type) /** * Gets status + * * @return string */ public function getStatus() @@ -910,7 +1086,9 @@ public function getStatus() /** * 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) @@ -921,7 +1099,9 @@ public function setStatus($status) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -931,7 +1111,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -941,8 +1123,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -956,7 +1140,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -966,16 +1152,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserSignatureDefinition.php b/src/Model/UserSignatureDefinition.php index 11369ace..7222e98c 100644 --- a/src/Model/UserSignatureDefinition.php +++ b/src/Model/UserSignatureDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserSignatureDefinition Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserSignatureDefinition implements ArrayAccess +class UserSignatureDefinition implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userSignatureDefinition'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -70,13 +73,52 @@ class UserSignatureDefinition implements ArrayAccess 'stamp_size_mm' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'date_stamp_properties' => null, + 'disallow_user_resize_stamp' => null, + 'external_id' => null, + 'image_type' => null, + 'is_default' => null, + 'nrds_id' => null, + 'nrds_last_name' => null, + 'phonetic_name' => null, + 'signature_font' => null, + 'signature_id' => null, + 'signature_initials' => null, + 'signature_name' => null, + 'stamp_format' => null, + 'stamp_size_mm' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -96,9 +138,9 @@ public static function swaggerTypes() 'stamp_size_mm' => 'stampSizeMM' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -118,9 +160,9 @@ public static function swaggerTypes() 'stamp_size_mm' => 'setStampSizeMm' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -140,34 +182,63 @@ public static function swaggerTypes() 'stamp_size_mm' => 'getStampSizeMm' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -188,30 +259,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets date_stamp_properties + * * @return \DocuSign\eSign\Model\DateStampProperties */ public function getDateStampProperties() @@ -221,7 +294,9 @@ public function getDateStampProperties() /** * Sets date_stamp_properties - * @param \DocuSign\eSign\Model\DateStampProperties $date_stamp_properties + * + * @param \DocuSign\eSign\Model\DateStampProperties $date_stamp_properties date_stamp_properties + * * @return $this */ public function setDateStampProperties($date_stamp_properties) @@ -233,6 +308,7 @@ public function setDateStampProperties($date_stamp_properties) /** * Gets disallow_user_resize_stamp + * * @return string */ public function getDisallowUserResizeStamp() @@ -242,7 +318,9 @@ public function getDisallowUserResizeStamp() /** * Sets disallow_user_resize_stamp + * * @param string $disallow_user_resize_stamp + * * @return $this */ public function setDisallowUserResizeStamp($disallow_user_resize_stamp) @@ -254,6 +332,7 @@ public function setDisallowUserResizeStamp($disallow_user_resize_stamp) /** * Gets external_id + * * @return string */ public function getExternalId() @@ -263,7 +342,9 @@ public function getExternalId() /** * Sets external_id + * * @param string $external_id + * * @return $this */ public function setExternalId($external_id) @@ -275,6 +356,7 @@ public function setExternalId($external_id) /** * Gets image_type + * * @return string */ public function getImageType() @@ -284,7 +366,9 @@ public function getImageType() /** * Sets image_type + * * @param string $image_type + * * @return $this */ public function setImageType($image_type) @@ -296,6 +380,7 @@ public function setImageType($image_type) /** * Gets is_default + * * @return string */ public function getIsDefault() @@ -305,7 +390,9 @@ public function getIsDefault() /** * Sets is_default + * * @param string $is_default + * * @return $this */ public function setIsDefault($is_default) @@ -317,6 +404,7 @@ public function setIsDefault($is_default) /** * Gets nrds_id + * * @return string */ public function getNrdsId() @@ -326,7 +414,9 @@ public function getNrdsId() /** * Sets nrds_id + * * @param string $nrds_id + * * @return $this */ public function setNrdsId($nrds_id) @@ -338,6 +428,7 @@ public function setNrdsId($nrds_id) /** * Gets nrds_last_name + * * @return string */ public function getNrdsLastName() @@ -347,7 +438,9 @@ public function getNrdsLastName() /** * Sets nrds_last_name + * * @param string $nrds_last_name + * * @return $this */ public function setNrdsLastName($nrds_last_name) @@ -359,6 +452,7 @@ public function setNrdsLastName($nrds_last_name) /** * Gets phonetic_name + * * @return string */ public function getPhoneticName() @@ -368,7 +462,9 @@ public function getPhoneticName() /** * Sets phonetic_name + * * @param string $phonetic_name + * * @return $this */ public function setPhoneticName($phonetic_name) @@ -380,6 +476,7 @@ public function setPhoneticName($phonetic_name) /** * Gets signature_font + * * @return string */ public function getSignatureFont() @@ -389,7 +486,9 @@ public function getSignatureFont() /** * Sets signature_font + * * @param string $signature_font + * * @return $this */ public function setSignatureFont($signature_font) @@ -401,6 +500,7 @@ public function setSignatureFont($signature_font) /** * Gets signature_id + * * @return string */ public function getSignatureId() @@ -410,7 +510,9 @@ public function getSignatureId() /** * Sets signature_id + * * @param string $signature_id Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. + * * @return $this */ public function setSignatureId($signature_id) @@ -422,6 +524,7 @@ public function setSignatureId($signature_id) /** * Gets signature_initials + * * @return string */ public function getSignatureInitials() @@ -431,7 +534,9 @@ public function getSignatureInitials() /** * Sets signature_initials + * * @param string $signature_initials + * * @return $this */ public function setSignatureInitials($signature_initials) @@ -443,6 +548,7 @@ public function setSignatureInitials($signature_initials) /** * Gets signature_name + * * @return string */ public function getSignatureName() @@ -452,7 +558,9 @@ public function getSignatureName() /** * Sets signature_name + * * @param string $signature_name Specifies the user signature name. + * * @return $this */ public function setSignatureName($signature_name) @@ -464,6 +572,7 @@ public function setSignatureName($signature_name) /** * Gets stamp_format + * * @return string */ public function getStampFormat() @@ -473,7 +582,9 @@ public function getStampFormat() /** * Sets stamp_format + * * @param string $stamp_format + * * @return $this */ public function setStampFormat($stamp_format) @@ -485,6 +596,7 @@ public function setStampFormat($stamp_format) /** * Gets stamp_size_mm + * * @return string */ public function getStampSizeMm() @@ -494,7 +606,9 @@ public function getStampSizeMm() /** * Sets stamp_size_mm + * * @param string $stamp_size_mm + * * @return $this */ public function setStampSizeMm($stamp_size_mm) @@ -505,7 +619,9 @@ public function setStampSizeMm($stamp_size_mm) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -515,7 +631,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -525,8 +643,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -540,7 +660,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -550,16 +672,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserSignaturesInformation.php b/src/Model/UserSignaturesInformation.php index 2922990f..e85222dc 100644 --- a/src/Model/UserSignaturesInformation.php +++ b/src/Model/UserSignaturesInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserSignaturesInformation Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserSignaturesInformation implements ArrayAccess +class UserSignaturesInformation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userSignaturesInformation'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'user_signatures' => '\DocuSign\eSign\Model\UserSignature[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'user_signatures' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'user_signatures' => 'userSignatures' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'user_signatures' => 'setUserSignatures' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'user_signatures' => 'getUserSignatures' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets user_signatures + * * @return \DocuSign\eSign\Model\UserSignature[] */ public function getUserSignatures() @@ -156,7 +216,9 @@ public function getUserSignatures() /** * Sets user_signatures + * * @param \DocuSign\eSign\Model\UserSignature[] $user_signatures + * * @return $this */ public function setUserSignatures($user_signatures) @@ -167,7 +229,9 @@ public function setUserSignatures($user_signatures) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UserSocialIdResult.php b/src/Model/UserSocialIdResult.php index 4aea97a9..bd8c2776 100644 --- a/src/Model/UserSocialIdResult.php +++ b/src/Model/UserSocialIdResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UserSocialIdResult Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UserSocialIdResult implements ArrayAccess +class UserSocialIdResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'userSocialIdResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -58,13 +61,40 @@ class UserSocialIdResult implements ArrayAccess 'user_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'social_account_information' => null, + 'user_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,63 @@ public static function swaggerTypes() 'user_id' => 'getUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -128,30 +187,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets social_account_information + * * @return \DocuSign\eSign\Model\SocialAccountInformation[] */ public function getSocialAccountInformation() @@ -161,7 +222,9 @@ public function getSocialAccountInformation() /** * Sets social_account_information + * * @param \DocuSign\eSign\Model\SocialAccountInformation[] $social_account_information Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.) + * * @return $this */ public function setSocialAccountInformation($social_account_information) @@ -173,6 +236,7 @@ public function setSocialAccountInformation($social_account_information) /** * Gets user_id + * * @return string */ public function getUserId() @@ -182,7 +246,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -193,7 +259,9 @@ public function setUserId($user_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -203,7 +271,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -213,8 +283,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -228,7 +300,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -238,16 +312,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/UsersResponse.php b/src/Model/UsersResponse.php index 21ac3a88..fe6fe19b 100644 --- a/src/Model/UsersResponse.php +++ b/src/Model/UsersResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * UsersResponse Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class UsersResponse implements ArrayAccess +class UsersResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'usersResponse'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class UsersResponse implements ArrayAccess 'users' => '\DocuSign\eSign\Model\UserInfo[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'next_uri' => null, + 'previous_uri' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null, + 'users' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'users' => 'users' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'users' => 'setUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,63 @@ public static function swaggerTypes() 'users' => 'getUsers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -153,30 +217,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -186,7 +252,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -198,6 +266,7 @@ public function setEndPosition($end_position) /** * Gets next_uri + * * @return string */ public function getNextUri() @@ -207,7 +276,9 @@ public function getNextUri() /** * 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) @@ -219,6 +290,7 @@ public function setNextUri($next_uri) /** * Gets previous_uri + * * @return string */ public function getPreviousUri() @@ -228,7 +300,9 @@ public function getPreviousUri() /** * Sets previous_uri + * * @param string $previous_uri The postal code for the billing address. + * * @return $this */ public function setPreviousUri($previous_uri) @@ -240,6 +314,7 @@ public function setPreviousUri($previous_uri) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -249,7 +324,9 @@ public function getResultSetSize() /** * 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) @@ -261,6 +338,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -270,7 +348,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -282,6 +362,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -291,7 +372,9 @@ public function getTotalSetSize() /** * 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) @@ -303,6 +386,7 @@ public function setTotalSetSize($total_set_size) /** * Gets users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getUsers() @@ -312,7 +396,9 @@ public function getUsers() /** * Sets users + * * @param \DocuSign\eSign\Model\UserInfo[] $users + * * @return $this */ public function setUsers($users) @@ -323,7 +409,9 @@ public function setUsers($users) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -333,7 +421,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -343,8 +433,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -358,7 +450,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -368,16 +462,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/View.php b/src/Model/View.php index 83750282..6bd09abc 100644 --- a/src/Model/View.php +++ b/src/Model/View.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * View Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class View implements ArrayAccess +class View implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'view'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -144,13 +147,126 @@ class View implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'button_text' => null, + 'button_text_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'required_read' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -244,9 +360,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -340,9 +456,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -436,34 +552,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -558,30 +703,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -591,7 +738,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -603,6 +752,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -612,7 +762,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -624,6 +776,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -633,7 +786,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -645,6 +800,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -654,7 +810,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -666,6 +824,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -675,7 +834,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -687,6 +848,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -696,7 +858,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -708,6 +872,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -717,7 +882,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -729,6 +896,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -738,7 +906,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -750,6 +920,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -759,7 +930,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -771,6 +944,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -780,7 +954,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -792,6 +968,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -801,7 +978,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -813,6 +992,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -822,7 +1002,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -834,6 +1016,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -843,7 +1026,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -855,6 +1040,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -864,7 +1050,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -876,6 +1064,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -885,7 +1074,9 @@ public function getAnchorUnits() /** * 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) @@ -897,6 +1088,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -906,7 +1098,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -918,6 +1112,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -927,7 +1122,9 @@ public function getAnchorXOffset() /** * 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) @@ -939,6 +1136,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -948,7 +1146,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -960,6 +1160,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -969,7 +1170,9 @@ public function getAnchorYOffset() /** * 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) @@ -981,6 +1184,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -990,7 +1194,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1002,6 +1208,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1011,7 +1218,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1023,6 +1232,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1032,7 +1242,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1044,6 +1256,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets button_text + * * @return string */ public function getButtonText() @@ -1053,7 +1266,9 @@ public function getButtonText() /** * Sets button_text + * * @param string $button_text + * * @return $this */ public function setButtonText($button_text) @@ -1065,6 +1280,7 @@ public function setButtonText($button_text) /** * Gets button_text_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getButtonTextMetadata() @@ -1074,7 +1290,9 @@ public function getButtonTextMetadata() /** * Sets button_text_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $button_text_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $button_text_metadata button_text_metadata + * * @return $this */ public function setButtonTextMetadata($button_text_metadata) @@ -1086,6 +1304,7 @@ public function setButtonTextMetadata($button_text_metadata) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1095,7 +1314,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1107,6 +1328,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1116,7 +1338,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1128,6 +1352,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1137,7 +1362,9 @@ public function getConditionalParentValue() /** * 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) @@ -1149,6 +1376,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1158,7 +1386,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1170,6 +1400,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1179,7 +1410,9 @@ public function getCustomTabId() /** * 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) @@ -1191,6 +1424,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1200,7 +1434,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1212,6 +1448,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1221,7 +1458,9 @@ public function getDocumentId() /** * 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) @@ -1233,6 +1472,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1242,7 +1482,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1254,6 +1496,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1263,7 +1506,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1275,6 +1520,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1284,7 +1530,9 @@ public function getFont() /** * 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) @@ -1296,6 +1544,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1305,7 +1554,9 @@ public function getFontColor() /** * 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) @@ -1317,6 +1568,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1326,7 +1578,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1338,6 +1592,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1347,7 +1602,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1359,6 +1616,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1368,7 +1626,9 @@ public function getFontSize() /** * 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) @@ -1380,6 +1640,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1389,7 +1650,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1401,6 +1664,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1410,7 +1674,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1422,6 +1688,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1431,7 +1698,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1443,6 +1712,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1452,7 +1722,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1464,6 +1736,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1473,7 +1746,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1485,6 +1760,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1494,7 +1770,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1506,6 +1784,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1515,7 +1794,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1527,6 +1808,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1536,7 +1818,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1548,6 +1832,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1557,7 +1842,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1569,6 +1856,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1578,7 +1866,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1590,6 +1880,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1599,7 +1890,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1611,6 +1904,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1620,7 +1914,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1632,6 +1928,7 @@ public function setLocalePolicy($locale_policy) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1641,7 +1938,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1653,6 +1952,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1662,7 +1962,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1674,6 +1976,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -1683,7 +1986,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -1695,6 +2000,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -1704,7 +2010,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -1716,6 +2024,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1725,7 +2034,9 @@ public function getRecipientId() /** * 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) @@ -1737,6 +2048,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1746,7 +2058,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1758,6 +2072,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -1767,7 +2082,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -1779,6 +2096,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -1788,7 +2106,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -1800,6 +2120,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -1809,7 +2130,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -1821,6 +2144,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -1830,7 +2154,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -1842,6 +2168,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets required_read + * * @return string */ public function getRequiredRead() @@ -1851,7 +2178,9 @@ public function getRequiredRead() /** * Sets required_read + * * @param string $required_read + * * @return $this */ public function setRequiredRead($required_read) @@ -1863,6 +2192,7 @@ public function setRequiredRead($required_read) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -1872,7 +2202,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -1884,6 +2216,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -1893,7 +2226,9 @@ public function getStatus() /** * 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) @@ -1905,6 +2240,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -1914,7 +2250,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -1926,6 +2264,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1935,7 +2274,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1947,6 +2288,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -1956,7 +2298,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -1968,6 +2312,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1977,7 +2322,9 @@ public function getTabId() /** * 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) @@ -1989,6 +2336,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -1998,7 +2346,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2010,6 +2360,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2019,7 +2370,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2031,6 +2384,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2040,7 +2394,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2052,6 +2408,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2061,7 +2418,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2073,6 +2432,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2082,7 +2442,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2094,6 +2456,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2103,7 +2466,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2115,6 +2480,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2124,7 +2490,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2136,6 +2504,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2145,7 +2514,9 @@ public function getTemplateLocked() /** * 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) @@ -2157,6 +2528,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2166,7 +2538,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2178,6 +2552,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2187,7 +2562,9 @@ public function getTemplateRequired() /** * 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) @@ -2199,6 +2576,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2208,7 +2586,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2220,6 +2600,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2229,7 +2610,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2241,6 +2624,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2250,7 +2634,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2262,6 +2648,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2271,7 +2658,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2283,6 +2672,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2292,7 +2682,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2304,6 +2696,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2313,7 +2706,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2325,6 +2720,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2334,7 +2730,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2346,6 +2744,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -2355,7 +2754,9 @@ public function getXPosition() /** * 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) @@ -2367,6 +2768,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -2376,7 +2778,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -2388,6 +2792,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -2397,7 +2802,9 @@ public function getYPosition() /** * 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) @@ -2409,6 +2816,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -2418,7 +2826,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -2429,7 +2839,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2439,7 +2851,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2449,8 +2863,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2464,7 +2880,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2474,16 +2892,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/ViewUrl.php b/src/Model/ViewUrl.php index 4d978324..7e8a85b7 100644 --- a/src/Model/ViewUrl.php +++ b/src/Model/ViewUrl.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ViewUrl Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ViewUrl implements ArrayAccess +class ViewUrl implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'viewUrl'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'url' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'url' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'url' => 'url' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'url' => 'setUrl' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'url' => 'getUrl' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets url + * * @return string */ public function getUrl() @@ -156,7 +216,9 @@ public function getUrl() /** * Sets url + * * @param string $url The view URL to be navigated to. + * * @return $this */ public function setUrl($url) @@ -167,7 +229,9 @@ public function setUrl($url) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Watermark.php b/src/Model/Watermark.php index 1817c59a..309ba877 100644 --- a/src/Model/Watermark.php +++ b/src/Model/Watermark.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Watermark Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Watermark implements ArrayAccess +class Watermark implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'watermark'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,47 @@ class Watermark implements ArrayAccess 'watermark_text' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'display_angle' => null, + 'enabled' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'id' => null, + 'image_base64' => null, + 'transparency' => null, + 'watermark_text' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -86,9 +123,9 @@ public static function swaggerTypes() 'watermark_text' => 'watermarkText' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -103,9 +140,9 @@ public static function swaggerTypes() 'watermark_text' => 'setWatermarkText' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -120,34 +157,63 @@ public static function swaggerTypes() 'watermark_text' => 'getWatermarkText' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -163,30 +229,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets display_angle + * * @return string */ public function getDisplayAngle() @@ -196,7 +264,9 @@ public function getDisplayAngle() /** * Sets display_angle + * * @param string $display_angle + * * @return $this */ public function setDisplayAngle($display_angle) @@ -208,6 +278,7 @@ public function setDisplayAngle($display_angle) /** * Gets enabled + * * @return string */ public function getEnabled() @@ -217,7 +288,9 @@ public function getEnabled() /** * Sets enabled + * * @param string $enabled + * * @return $this */ public function setEnabled($enabled) @@ -229,6 +302,7 @@ public function setEnabled($enabled) /** * Gets font + * * @return string */ public function getFont() @@ -238,7 +312,9 @@ public function getFont() /** * 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) @@ -250,6 +326,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -259,7 +336,9 @@ public function getFontColor() /** * 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) @@ -271,6 +350,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -280,7 +360,9 @@ public function getFontSize() /** * 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) @@ -292,6 +374,7 @@ public function setFontSize($font_size) /** * Gets id + * * @return string */ public function getId() @@ -301,7 +384,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -313,6 +398,7 @@ public function setId($id) /** * Gets image_base64 + * * @return string */ public function getImageBase64() @@ -322,7 +408,9 @@ public function getImageBase64() /** * Sets image_base64 + * * @param string $image_base64 + * * @return $this */ public function setImageBase64($image_base64) @@ -334,6 +422,7 @@ public function setImageBase64($image_base64) /** * Gets transparency + * * @return string */ public function getTransparency() @@ -343,7 +432,9 @@ public function getTransparency() /** * Sets transparency + * * @param string $transparency + * * @return $this */ public function setTransparency($transparency) @@ -355,6 +446,7 @@ public function setTransparency($transparency) /** * Gets watermark_text + * * @return string */ public function getWatermarkText() @@ -364,7 +456,9 @@ public function getWatermarkText() /** * Sets watermark_text + * * @param string $watermark_text + * * @return $this */ public function setWatermarkText($watermark_text) @@ -375,7 +469,9 @@ public function setWatermarkText($watermark_text) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -385,7 +481,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -395,8 +493,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -410,7 +510,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -420,16 +522,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Witness.php b/src/Model/Witness.php index 08e84d16..c57ffe73 100644 --- a/src/Model/Witness.php +++ b/src/Model/Witness.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Witness Class Doc Comment @@ -39,24 +40,28 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Witness implements ArrayAccess +class Witness implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'witness'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'access_code' => 'string', 'access_code_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'add_access_code_to_email' => 'string', + 'additional_notifications' => '\DocuSign\eSign\Model\RecipientAdditionalNotification[]', + 'additional_notifications_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'agent_can_edit_email' => 'string', 'agent_can_edit_name' => 'string', 'allow_system_override_for_locked_recipient' => 'string', @@ -146,19 +151,138 @@ class Witness implements ArrayAccess 'witness_for_guid' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'access_code' => null, + 'access_code_metadata' => null, + 'add_access_code_to_email' => null, + 'additional_notifications' => null, + 'additional_notifications_metadata' => null, + 'agent_can_edit_email' => null, + 'agent_can_edit_name' => null, + 'allow_system_override_for_locked_recipient' => null, + 'auto_navigation' => null, + 'bulk_recipients_uri' => null, + 'can_sign_offline' => null, + 'client_user_id' => null, + 'completed_count' => null, + 'creation_reason' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'default_recipient' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'delivery_method_metadata' => null, + 'designator_id' => null, + 'designator_id_guid' => null, + 'document_visibility' => null, + 'email' => null, + 'email_metadata' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'fax_number_metadata' => null, + 'first_name' => null, + 'first_name_metadata' => null, + 'full_name' => null, + 'full_name_metadata' => null, + 'id_check_configuration_name' => null, + 'id_check_configuration_name_metadata' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'is_bulk_recipient' => null, + 'is_bulk_recipient_metadata' => null, + 'last_name' => null, + 'last_name_metadata' => null, + 'locked_recipient_phone_auth_editable' => null, + 'locked_recipient_sms_editable' => null, + 'name' => null, + 'name_metadata' => null, + 'note' => null, + 'note_metadata' => null, + 'offline_attributes' => null, + 'phone_authentication' => null, + 'proof_file' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_feature_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_signature_providers' => null, + 'recipient_supplies_tabs' => null, + 'recipient_type' => null, + 'recipient_type_metadata' => null, + 'require_id_lookup' => null, + 'require_id_lookup_metadata' => null, + 'require_signer_certificate' => null, + 'require_sign_on_paper' => null, + 'require_upload_signature' => null, + 'role_name' => null, + 'routing_order' => null, + 'routing_order_metadata' => null, + 'sent_date_time' => null, + 'signature_info' => null, + 'signed_date_time' => null, + 'sign_in_each_location' => null, + 'sign_in_each_location_metadata' => null, + 'signing_group_id' => null, + 'signing_group_id_metadata' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => null, + 'status_code' => null, + 'suppress_emails' => null, + 'tabs' => null, + 'template_locked' => null, + 'template_required' => null, + 'total_tab_count' => null, + 'user_id' => null, + 'witness_for' => null, + 'witness_for_guid' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'access_code' => 'accessCode', 'access_code_metadata' => 'accessCodeMetadata', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'additional_notifications' => 'additionalNotifications', + 'additional_notifications_metadata' => 'additionalNotificationsMetadata', 'agent_can_edit_email' => 'agentCanEditEmail', 'agent_can_edit_name' => 'agentCanEditName', 'allow_system_override_for_locked_recipient' => 'allowSystemOverrideForLockedRecipient', @@ -248,15 +372,17 @@ public static function swaggerTypes() 'witness_for_guid' => 'witnessForGuid' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'access_code' => 'setAccessCode', 'access_code_metadata' => 'setAccessCodeMetadata', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'additional_notifications' => 'setAdditionalNotifications', + 'additional_notifications_metadata' => 'setAdditionalNotificationsMetadata', 'agent_can_edit_email' => 'setAgentCanEditEmail', 'agent_can_edit_name' => 'setAgentCanEditName', 'allow_system_override_for_locked_recipient' => 'setAllowSystemOverrideForLockedRecipient', @@ -346,15 +472,17 @@ public static function swaggerTypes() 'witness_for_guid' => 'setWitnessForGuid' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'access_code' => 'getAccessCode', 'access_code_metadata' => 'getAccessCodeMetadata', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'additional_notifications' => 'getAdditionalNotifications', + 'additional_notifications_metadata' => 'getAdditionalNotificationsMetadata', 'agent_can_edit_email' => 'getAgentCanEditEmail', 'agent_can_edit_name' => 'getAgentCanEditName', 'allow_system_override_for_locked_recipient' => 'getAllowSystemOverrideForLockedRecipient', @@ -444,40 +572,71 @@ public static function swaggerTypes() 'witness_for_guid' => 'getWitnessForGuid' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @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['access_code_metadata'] = isset($data['access_code_metadata']) ? $data['access_code_metadata'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['additional_notifications'] = isset($data['additional_notifications']) ? $data['additional_notifications'] : null; + $this->container['additional_notifications_metadata'] = isset($data['additional_notifications_metadata']) ? $data['additional_notifications_metadata'] : 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['allow_system_override_for_locked_recipient'] = isset($data['allow_system_override_for_locked_recipient']) ? $data['allow_system_override_for_locked_recipient'] : null; @@ -568,30 +727,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets access_code + * * @return string */ public function getAccessCode() @@ -601,7 +762,9 @@ 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. + * * @return $this */ public function setAccessCode($access_code) @@ -613,6 +776,7 @@ public function setAccessCode($access_code) /** * Gets access_code_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAccessCodeMetadata() @@ -622,7 +786,9 @@ public function getAccessCodeMetadata() /** * Sets access_code_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $access_code_metadata access_code_metadata + * * @return $this */ public function setAccessCodeMetadata($access_code_metadata) @@ -634,6 +800,7 @@ public function setAccessCodeMetadata($access_code_metadata) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -643,7 +810,9 @@ public function getAddAccessCodeToEmail() /** * 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) @@ -653,8 +822,57 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets additional_notifications + * + * @return \DocuSign\eSign\Model\RecipientAdditionalNotification[] + */ + public function getAdditionalNotifications() + { + return $this->container['additional_notifications']; + } + + /** + * Sets additional_notifications + * + * @param \DocuSign\eSign\Model\RecipientAdditionalNotification[] $additional_notifications + * + * @return $this + */ + public function setAdditionalNotifications($additional_notifications) + { + $this->container['additional_notifications'] = $additional_notifications; + + return $this; + } + + /** + * Gets additional_notifications_metadata + * + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getAdditionalNotificationsMetadata() + { + return $this->container['additional_notifications_metadata']; + } + + /** + * Sets additional_notifications_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $additional_notifications_metadata additional_notifications_metadata + * + * @return $this + */ + public function setAdditionalNotificationsMetadata($additional_notifications_metadata) + { + $this->container['additional_notifications_metadata'] = $additional_notifications_metadata; + + return $this; + } + /** * Gets agent_can_edit_email + * * @return string */ public function getAgentCanEditEmail() @@ -664,7 +882,9 @@ public function getAgentCanEditEmail() /** * Sets agent_can_edit_email + * * @param string $agent_can_edit_email + * * @return $this */ public function setAgentCanEditEmail($agent_can_edit_email) @@ -676,6 +896,7 @@ public function setAgentCanEditEmail($agent_can_edit_email) /** * Gets agent_can_edit_name + * * @return string */ public function getAgentCanEditName() @@ -685,7 +906,9 @@ public function getAgentCanEditName() /** * Sets agent_can_edit_name + * * @param string $agent_can_edit_name + * * @return $this */ public function setAgentCanEditName($agent_can_edit_name) @@ -697,6 +920,7 @@ public function setAgentCanEditName($agent_can_edit_name) /** * Gets allow_system_override_for_locked_recipient + * * @return string */ public function getAllowSystemOverrideForLockedRecipient() @@ -706,7 +930,9 @@ public function getAllowSystemOverrideForLockedRecipient() /** * Sets allow_system_override_for_locked_recipient + * * @param string $allow_system_override_for_locked_recipient + * * @return $this */ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_for_locked_recipient) @@ -718,6 +944,7 @@ public function setAllowSystemOverrideForLockedRecipient($allow_system_override_ /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -727,7 +954,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -739,6 +968,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets bulk_recipients_uri + * * @return string */ public function getBulkRecipientsUri() @@ -748,7 +978,9 @@ public function getBulkRecipientsUri() /** * 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) @@ -760,6 +992,7 @@ public function setBulkRecipientsUri($bulk_recipients_uri) /** * Gets can_sign_offline + * * @return string */ public function getCanSignOffline() @@ -769,7 +1002,9 @@ public function getCanSignOffline() /** * 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) @@ -781,6 +1016,7 @@ public function setCanSignOffline($can_sign_offline) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -790,7 +1026,9 @@ public function getClientUserId() /** * 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) @@ -802,6 +1040,7 @@ public function setClientUserId($client_user_id) /** * Gets completed_count + * * @return string */ public function getCompletedCount() @@ -811,7 +1050,9 @@ public function getCompletedCount() /** * Sets completed_count + * * @param string $completed_count + * * @return $this */ public function setCompletedCount($completed_count) @@ -823,6 +1064,7 @@ public function setCompletedCount($completed_count) /** * Gets creation_reason + * * @return string */ public function getCreationReason() @@ -832,7 +1074,9 @@ public function getCreationReason() /** * Sets creation_reason + * * @param string $creation_reason + * * @return $this */ public function setCreationReason($creation_reason) @@ -844,6 +1088,7 @@ public function setCreationReason($creation_reason) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -853,7 +1098,9 @@ public function getCustomFields() /** * 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) @@ -865,6 +1112,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -874,7 +1122,9 @@ public function getDeclinedDateTime() /** * 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) @@ -886,6 +1136,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -895,7 +1146,9 @@ public function getDeclinedReason() /** * Sets declined_reason + * * @param string $declined_reason The reason the recipient declined the document. + * * @return $this */ public function setDeclinedReason($declined_reason) @@ -907,6 +1160,7 @@ public function setDeclinedReason($declined_reason) /** * Gets default_recipient + * * @return string */ public function getDefaultRecipient() @@ -916,7 +1170,9 @@ public function getDefaultRecipient() /** * Sets default_recipient + * * @param string $default_recipient + * * @return $this */ public function setDefaultRecipient($default_recipient) @@ -928,6 +1184,7 @@ public function setDefaultRecipient($default_recipient) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -937,7 +1194,9 @@ public function getDeliveredDateTime() /** * Sets delivered_date_time + * * @param string $delivered_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveredDateTime($delivered_date_time) @@ -949,6 +1208,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -958,7 +1218,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -970,6 +1232,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets delivery_method_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDeliveryMethodMetadata() @@ -979,7 +1242,9 @@ public function getDeliveryMethodMetadata() /** * Sets delivery_method_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $delivery_method_metadata delivery_method_metadata + * * @return $this */ public function setDeliveryMethodMetadata($delivery_method_metadata) @@ -991,6 +1256,7 @@ public function setDeliveryMethodMetadata($delivery_method_metadata) /** * Gets designator_id + * * @return string */ public function getDesignatorId() @@ -1000,7 +1266,9 @@ public function getDesignatorId() /** * Sets designator_id + * * @param string $designator_id + * * @return $this */ public function setDesignatorId($designator_id) @@ -1012,6 +1280,7 @@ public function setDesignatorId($designator_id) /** * Gets designator_id_guid + * * @return string */ public function getDesignatorIdGuid() @@ -1021,7 +1290,9 @@ public function getDesignatorIdGuid() /** * Sets designator_id_guid + * * @param string $designator_id_guid + * * @return $this */ public function setDesignatorIdGuid($designator_id_guid) @@ -1033,6 +1304,7 @@ public function setDesignatorIdGuid($designator_id_guid) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -1042,7 +1314,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -1054,6 +1328,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -1063,7 +1338,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -1075,6 +1352,7 @@ public function setEmail($email) /** * Gets email_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getEmailMetadata() @@ -1084,7 +1362,9 @@ public function getEmailMetadata() /** * Sets email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $email_metadata email_metadata + * * @return $this */ public function setEmailMetadata($email_metadata) @@ -1096,6 +1376,7 @@ public function setEmailMetadata($email_metadata) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -1105,7 +1386,9 @@ public function getEmailNotification() /** * Sets email_notification - * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification email_notification + * * @return $this */ public function setEmailNotification($email_notification) @@ -1117,6 +1400,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -1126,7 +1410,9 @@ 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]]` + * * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -1138,6 +1424,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1147,7 +1434,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1159,6 +1448,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -1168,7 +1458,9 @@ public function getExcludedDocuments() /** * 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) @@ -1180,6 +1472,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -1189,7 +1482,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -1201,6 +1496,7 @@ public function setFaxNumber($fax_number) /** * Gets fax_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFaxNumberMetadata() @@ -1210,7 +1506,9 @@ public function getFaxNumberMetadata() /** * Sets fax_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $fax_number_metadata fax_number_metadata + * * @return $this */ public function setFaxNumberMetadata($fax_number_metadata) @@ -1222,6 +1520,7 @@ public function setFaxNumberMetadata($fax_number_metadata) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -1231,7 +1530,9 @@ public function getFirstName() /** * Sets first_name + * * @param string $first_name The user's first name. Maximum Length: 50 characters. + * * @return $this */ public function setFirstName($first_name) @@ -1243,6 +1544,7 @@ public function setFirstName($first_name) /** * Gets first_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFirstNameMetadata() @@ -1252,7 +1554,9 @@ public function getFirstNameMetadata() /** * Sets first_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $first_name_metadata first_name_metadata + * * @return $this */ public function setFirstNameMetadata($first_name_metadata) @@ -1264,6 +1568,7 @@ public function setFirstNameMetadata($first_name_metadata) /** * Gets full_name + * * @return string */ public function getFullName() @@ -1273,7 +1578,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -1285,6 +1592,7 @@ public function setFullName($full_name) /** * Gets full_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFullNameMetadata() @@ -1294,7 +1602,9 @@ public function getFullNameMetadata() /** * Sets full_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $full_name_metadata full_name_metadata + * * @return $this */ public function setFullNameMetadata($full_name_metadata) @@ -1306,6 +1616,7 @@ public function setFullNameMetadata($full_name_metadata) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -1315,7 +1626,9 @@ public function getIdCheckConfigurationName() /** * 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) @@ -1327,6 +1640,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_configuration_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIdCheckConfigurationNameMetadata() @@ -1336,7 +1650,9 @@ public function getIdCheckConfigurationNameMetadata() /** * Sets id_check_configuration_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $id_check_configuration_name_metadata id_check_configuration_name_metadata + * * @return $this */ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name_metadata) @@ -1348,6 +1664,7 @@ public function setIdCheckConfigurationNameMetadata($id_check_configuration_name /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1357,7 +1674,9 @@ public function getIdCheckInformationInput() /** * Sets id_check_information_input - * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input id_check_information_input + * * @return $this */ public function setIdCheckInformationInput($id_check_information_input) @@ -1369,6 +1688,7 @@ public function setIdCheckInformationInput($id_check_information_input) /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\RecipientIdentityVerification */ public function getIdentityVerification() @@ -1378,7 +1698,9 @@ public function getIdentityVerification() /** * Sets identity_verification - * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification + * + * @param \DocuSign\eSign\Model\RecipientIdentityVerification $identity_verification identity_verification + * * @return $this */ public function setIdentityVerification($identity_verification) @@ -1390,6 +1712,7 @@ public function setIdentityVerification($identity_verification) /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1399,7 +1722,9 @@ public function getInheritEmailNotificationConfiguration() /** * 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) @@ -1411,6 +1736,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets is_bulk_recipient + * * @return string */ public function getIsBulkRecipient() @@ -1420,7 +1746,9 @@ public function getIsBulkRecipient() /** * Sets is_bulk_recipient + * * @param string $is_bulk_recipient + * * @return $this */ public function setIsBulkRecipient($is_bulk_recipient) @@ -1432,6 +1760,7 @@ public function setIsBulkRecipient($is_bulk_recipient) /** * Gets is_bulk_recipient_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getIsBulkRecipientMetadata() @@ -1441,7 +1770,9 @@ public function getIsBulkRecipientMetadata() /** * Sets is_bulk_recipient_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $is_bulk_recipient_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $is_bulk_recipient_metadata is_bulk_recipient_metadata + * * @return $this */ public function setIsBulkRecipientMetadata($is_bulk_recipient_metadata) @@ -1453,6 +1784,7 @@ public function setIsBulkRecipientMetadata($is_bulk_recipient_metadata) /** * Gets last_name + * * @return string */ public function getLastName() @@ -1462,7 +1794,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -1474,6 +1808,7 @@ public function setLastName($last_name) /** * Gets last_name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLastNameMetadata() @@ -1483,7 +1818,9 @@ public function getLastNameMetadata() /** * Sets last_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $last_name_metadata last_name_metadata + * * @return $this */ public function setLastNameMetadata($last_name_metadata) @@ -1495,6 +1832,7 @@ public function setLastNameMetadata($last_name_metadata) /** * Gets locked_recipient_phone_auth_editable + * * @return string */ public function getLockedRecipientPhoneAuthEditable() @@ -1504,7 +1842,9 @@ public function getLockedRecipientPhoneAuthEditable() /** * Sets locked_recipient_phone_auth_editable + * * @param string $locked_recipient_phone_auth_editable + * * @return $this */ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth_editable) @@ -1516,6 +1856,7 @@ public function setLockedRecipientPhoneAuthEditable($locked_recipient_phone_auth /** * Gets locked_recipient_sms_editable + * * @return string */ public function getLockedRecipientSmsEditable() @@ -1525,7 +1866,9 @@ public function getLockedRecipientSmsEditable() /** * Sets locked_recipient_sms_editable + * * @param string $locked_recipient_sms_editable + * * @return $this */ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) @@ -1537,6 +1880,7 @@ public function setLockedRecipientSmsEditable($locked_recipient_sms_editable) /** * Gets name + * * @return string */ public function getName() @@ -1546,7 +1890,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1558,6 +1904,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1567,7 +1914,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1579,6 +1928,7 @@ public function setNameMetadata($name_metadata) /** * Gets note + * * @return string */ public function getNote() @@ -1588,7 +1938,9 @@ public function getNote() /** * 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) @@ -1600,6 +1952,7 @@ public function setNote($note) /** * Gets note_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNoteMetadata() @@ -1609,7 +1962,9 @@ public function getNoteMetadata() /** * Sets note_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $note_metadata note_metadata + * * @return $this */ public function setNoteMetadata($note_metadata) @@ -1621,6 +1976,7 @@ public function setNoteMetadata($note_metadata) /** * Gets offline_attributes + * * @return \DocuSign\eSign\Model\OfflineAttributes */ public function getOfflineAttributes() @@ -1630,7 +1986,9 @@ public function getOfflineAttributes() /** * Sets offline_attributes - * @param \DocuSign\eSign\Model\OfflineAttributes $offline_attributes + * + * @param \DocuSign\eSign\Model\OfflineAttributes $offline_attributes offline_attributes + * * @return $this */ public function setOfflineAttributes($offline_attributes) @@ -1642,6 +2000,7 @@ public function setOfflineAttributes($offline_attributes) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1651,7 +2010,9 @@ public function getPhoneAuthentication() /** * Sets phone_authentication - * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication phone_authentication + * * @return $this */ public function setPhoneAuthentication($phone_authentication) @@ -1663,6 +2024,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets proof_file + * * @return \DocuSign\eSign\Model\RecipientProofFile */ public function getProofFile() @@ -1672,7 +2034,9 @@ public function getProofFile() /** * Sets proof_file - * @param \DocuSign\eSign\Model\RecipientProofFile $proof_file + * + * @param \DocuSign\eSign\Model\RecipientProofFile $proof_file proof_file + * * @return $this */ public function setProofFile($proof_file) @@ -1684,6 +2048,7 @@ public function setProofFile($proof_file) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1693,7 +2058,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1705,6 +2072,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1714,7 +2082,9 @@ public function getRecipientAuthenticationStatus() /** * Sets recipient_authentication_status - * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status recipient_authentication_status + * * @return $this */ public function setRecipientAuthenticationStatus($recipient_authentication_status) @@ -1726,6 +2096,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_feature_metadata + * * @return \DocuSign\eSign\Model\FeatureAvailableMetadata[] */ public function getRecipientFeatureMetadata() @@ -1735,7 +2106,9 @@ public function getRecipientFeatureMetadata() /** * Sets recipient_feature_metadata + * * @param \DocuSign\eSign\Model\FeatureAvailableMetadata[] $recipient_feature_metadata + * * @return $this */ public function setRecipientFeatureMetadata($recipient_feature_metadata) @@ -1747,6 +2120,7 @@ public function setRecipientFeatureMetadata($recipient_feature_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1756,7 +2130,9 @@ public function getRecipientId() /** * 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) @@ -1768,6 +2144,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1777,7 +2154,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1789,6 +2168,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -1798,7 +2178,9 @@ public function getRecipientSignatureProviders() /** * Sets recipient_signature_providers + * * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * * @return $this */ public function setRecipientSignatureProviders($recipient_signature_providers) @@ -1810,6 +2192,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets recipient_supplies_tabs + * * @return string */ public function getRecipientSuppliesTabs() @@ -1819,7 +2202,9 @@ public function getRecipientSuppliesTabs() /** * Sets recipient_supplies_tabs + * * @param string $recipient_supplies_tabs + * * @return $this */ public function setRecipientSuppliesTabs($recipient_supplies_tabs) @@ -1831,6 +2216,7 @@ public function setRecipientSuppliesTabs($recipient_supplies_tabs) /** * Gets recipient_type + * * @return string */ public function getRecipientType() @@ -1840,7 +2226,9 @@ public function getRecipientType() /** * Sets recipient_type + * * @param string $recipient_type + * * @return $this */ public function setRecipientType($recipient_type) @@ -1852,6 +2240,7 @@ public function setRecipientType($recipient_type) /** * Gets recipient_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientTypeMetadata() @@ -1861,7 +2250,9 @@ public function getRecipientTypeMetadata() /** * Sets recipient_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_type_metadata recipient_type_metadata + * * @return $this */ public function setRecipientTypeMetadata($recipient_type_metadata) @@ -1873,6 +2264,7 @@ public function setRecipientTypeMetadata($recipient_type_metadata) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1882,7 +2274,9 @@ public function getRequireIdLookup() /** * 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) @@ -1894,6 +2288,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_id_lookup_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireIdLookupMetadata() @@ -1903,7 +2298,9 @@ public function getRequireIdLookupMetadata() /** * Sets require_id_lookup_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_id_lookup_metadata require_id_lookup_metadata + * * @return $this */ public function setRequireIdLookupMetadata($require_id_lookup_metadata) @@ -1915,6 +2312,7 @@ public function setRequireIdLookupMetadata($require_id_lookup_metadata) /** * Gets require_signer_certificate + * * @return string */ public function getRequireSignerCertificate() @@ -1924,7 +2322,9 @@ public function getRequireSignerCertificate() /** * Sets require_signer_certificate + * * @param string $require_signer_certificate + * * @return $this */ public function setRequireSignerCertificate($require_signer_certificate) @@ -1936,6 +2336,7 @@ public function setRequireSignerCertificate($require_signer_certificate) /** * Gets require_sign_on_paper + * * @return string */ public function getRequireSignOnPaper() @@ -1945,7 +2346,9 @@ public function getRequireSignOnPaper() /** * Sets require_sign_on_paper + * * @param string $require_sign_on_paper + * * @return $this */ public function setRequireSignOnPaper($require_sign_on_paper) @@ -1957,6 +2360,7 @@ public function setRequireSignOnPaper($require_sign_on_paper) /** * Gets require_upload_signature + * * @return string */ public function getRequireUploadSignature() @@ -1966,7 +2370,9 @@ public function getRequireUploadSignature() /** * Sets require_upload_signature + * * @param string $require_upload_signature + * * @return $this */ public function setRequireUploadSignature($require_upload_signature) @@ -1978,6 +2384,7 @@ public function setRequireUploadSignature($require_upload_signature) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1987,7 +2394,9 @@ public function getRoleName() /** * 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) @@ -1999,6 +2408,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -2008,7 +2418,9 @@ public function getRoutingOrder() /** * Sets routing_order + * * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * * @return $this */ public function setRoutingOrder($routing_order) @@ -2020,6 +2432,7 @@ public function setRoutingOrder($routing_order) /** * Gets routing_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRoutingOrderMetadata() @@ -2029,7 +2442,9 @@ public function getRoutingOrderMetadata() /** * Sets routing_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $routing_order_metadata routing_order_metadata + * * @return $this */ public function setRoutingOrderMetadata($routing_order_metadata) @@ -2041,6 +2456,7 @@ public function setRoutingOrderMetadata($routing_order_metadata) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -2050,7 +2466,9 @@ public function getSentDateTime() /** * 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) @@ -2062,6 +2480,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signature_info + * * @return \DocuSign\eSign\Model\RecipientSignatureInformation */ public function getSignatureInfo() @@ -2071,7 +2490,9 @@ public function getSignatureInfo() /** * Sets signature_info - * @param \DocuSign\eSign\Model\RecipientSignatureInformation $signature_info + * + * @param \DocuSign\eSign\Model\RecipientSignatureInformation $signature_info signature_info + * * @return $this */ public function setSignatureInfo($signature_info) @@ -2083,6 +2504,7 @@ public function setSignatureInfo($signature_info) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -2092,7 +2514,9 @@ public function getSignedDateTime() /** * Sets signed_date_time + * * @param string $signed_date_time Reserved: For DocuSign use only. + * * @return $this */ public function setSignedDateTime($signed_date_time) @@ -2104,6 +2528,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets sign_in_each_location + * * @return string */ public function getSignInEachLocation() @@ -2113,7 +2538,9 @@ public function getSignInEachLocation() /** * 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) @@ -2125,6 +2552,7 @@ public function setSignInEachLocation($sign_in_each_location) /** * Gets sign_in_each_location_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSignInEachLocationMetadata() @@ -2134,7 +2562,9 @@ public function getSignInEachLocationMetadata() /** * Sets sign_in_each_location_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sign_in_each_location_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sign_in_each_location_metadata sign_in_each_location_metadata + * * @return $this */ public function setSignInEachLocationMetadata($sign_in_each_location_metadata) @@ -2146,6 +2576,7 @@ public function setSignInEachLocationMetadata($sign_in_each_location_metadata) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -2155,7 +2586,9 @@ public function getSigningGroupId() /** * 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) @@ -2167,6 +2600,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSigningGroupIdMetadata() @@ -2176,7 +2610,9 @@ public function getSigningGroupIdMetadata() /** * Sets signing_group_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $signing_group_id_metadata signing_group_id_metadata + * * @return $this */ public function setSigningGroupIdMetadata($signing_group_id_metadata) @@ -2188,6 +2624,7 @@ public function setSigningGroupIdMetadata($signing_group_id_metadata) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -2197,7 +2634,9 @@ public function getSigningGroupName() /** * 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) @@ -2209,6 +2648,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -2218,7 +2658,9 @@ public function getSigningGroupUsers() /** * 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) @@ -2230,6 +2672,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -2239,7 +2682,9 @@ public function getSmsAuthentication() /** * Sets sms_authentication - * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication sms_authentication + * * @return $this */ public function setSmsAuthentication($sms_authentication) @@ -2251,6 +2696,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -2260,7 +2706,9 @@ public function getSocialAuthentications() /** * 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) @@ -2272,6 +2720,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -2281,7 +2730,9 @@ public function getStatus() /** * 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) @@ -2293,6 +2744,7 @@ public function setStatus($status) /** * Gets status_code + * * @return string */ public function getStatusCode() @@ -2302,7 +2754,9 @@ public function getStatusCode() /** * Sets status_code + * * @param string $status_code + * * @return $this */ public function setStatusCode($status_code) @@ -2314,6 +2768,7 @@ public function setStatusCode($status_code) /** * Gets suppress_emails + * * @return string */ public function getSuppressEmails() @@ -2323,7 +2778,9 @@ public function getSuppressEmails() /** * Sets suppress_emails + * * @param string $suppress_emails + * * @return $this */ public function setSuppressEmails($suppress_emails) @@ -2335,6 +2792,7 @@ public function setSuppressEmails($suppress_emails) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -2344,7 +2802,9 @@ public function getTabs() /** * Sets tabs - * @param \DocuSign\eSign\Model\Tabs $tabs + * + * @param \DocuSign\eSign\Model\Tabs $tabs tabs + * * @return $this */ public function setTabs($tabs) @@ -2356,6 +2816,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2365,7 +2826,9 @@ public function getTemplateLocked() /** * 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) @@ -2377,6 +2840,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2386,7 +2850,9 @@ public function getTemplateRequired() /** * 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) @@ -2398,6 +2864,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -2407,7 +2874,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -2419,6 +2888,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -2428,7 +2898,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -2440,6 +2912,7 @@ public function setUserId($user_id) /** * Gets witness_for + * * @return string */ public function getWitnessFor() @@ -2449,7 +2922,9 @@ public function getWitnessFor() /** * Sets witness_for + * * @param string $witness_for + * * @return $this */ public function setWitnessFor($witness_for) @@ -2461,6 +2936,7 @@ public function setWitnessFor($witness_for) /** * Gets witness_for_guid + * * @return string */ public function getWitnessForGuid() @@ -2470,7 +2946,9 @@ public function getWitnessForGuid() /** * Sets witness_for_guid + * * @param string $witness_for_guid + * * @return $this */ public function setWitnessForGuid($witness_for_guid) @@ -2481,7 +2959,9 @@ public function setWitnessForGuid($witness_for_guid) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -2491,7 +2971,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -2501,8 +2983,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -2516,7 +3000,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2526,16 +3012,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Workspace.php b/src/Model/Workspace.php index 09913830..9c429e98 100644 --- a/src/Model/Workspace.php +++ b/src/Model/Workspace.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Workspace Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Workspace implements ArrayAccess +class Workspace implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'workspace'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -70,13 +73,51 @@ class Workspace implements ArrayAccess 'workspace_uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'billable_account_id' => null, + 'caller_information' => null, + 'created' => null, + 'created_by_information' => null, + 'last_modified' => null, + 'last_modified_by_information' => null, + 'settings' => null, + 'status' => null, + 'workspace_base_url' => null, + 'workspace_description' => null, + 'workspace_id' => null, + 'workspace_name' => null, + 'workspace_uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -95,9 +136,9 @@ public static function swaggerTypes() 'workspace_uri' => 'workspaceUri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -116,9 +157,9 @@ public static function swaggerTypes() 'workspace_uri' => 'setWorkspaceUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -137,34 +178,63 @@ public static function swaggerTypes() 'workspace_uri' => 'getWorkspaceUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -184,30 +254,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets billable_account_id + * * @return string */ public function getBillableAccountId() @@ -217,7 +289,9 @@ public function getBillableAccountId() /** * Sets billable_account_id + * * @param string $billable_account_id + * * @return $this */ public function setBillableAccountId($billable_account_id) @@ -229,6 +303,7 @@ public function setBillableAccountId($billable_account_id) /** * Gets caller_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getCallerInformation() @@ -238,7 +313,9 @@ public function getCallerInformation() /** * Sets caller_information - * @param \DocuSign\eSign\Model\WorkspaceUser $caller_information + * + * @param \DocuSign\eSign\Model\WorkspaceUser $caller_information caller_information + * * @return $this */ public function setCallerInformation($caller_information) @@ -250,6 +327,7 @@ public function setCallerInformation($caller_information) /** * Gets created + * * @return string */ public function getCreated() @@ -259,7 +337,9 @@ public function getCreated() /** * Sets created + * * @param string $created + * * @return $this */ public function setCreated($created) @@ -271,6 +351,7 @@ public function setCreated($created) /** * Gets created_by_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getCreatedByInformation() @@ -280,7 +361,9 @@ public function getCreatedByInformation() /** * Sets created_by_information - * @param \DocuSign\eSign\Model\WorkspaceUser $created_by_information + * + * @param \DocuSign\eSign\Model\WorkspaceUser $created_by_information created_by_information + * * @return $this */ public function setCreatedByInformation($created_by_information) @@ -292,6 +375,7 @@ public function setCreatedByInformation($created_by_information) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -301,7 +385,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified Utc date and time the comment was last updated (can only be done by creator.) + * * @return $this */ public function setLastModified($last_modified) @@ -313,6 +399,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_by_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getLastModifiedByInformation() @@ -322,7 +409,9 @@ public function getLastModifiedByInformation() /** * Sets last_modified_by_information - * @param \DocuSign\eSign\Model\WorkspaceUser $last_modified_by_information + * + * @param \DocuSign\eSign\Model\WorkspaceUser $last_modified_by_information last_modified_by_information + * * @return $this */ public function setLastModifiedByInformation($last_modified_by_information) @@ -334,6 +423,7 @@ public function setLastModifiedByInformation($last_modified_by_information) /** * Gets settings + * * @return \DocuSign\eSign\Model\WorkspaceSettings */ public function getSettings() @@ -343,7 +433,9 @@ public function getSettings() /** * Sets settings - * @param \DocuSign\eSign\Model\WorkspaceSettings $settings + * + * @param \DocuSign\eSign\Model\WorkspaceSettings $settings settings + * * @return $this */ public function setSettings($settings) @@ -355,6 +447,7 @@ public function setSettings($settings) /** * Gets status + * * @return string */ public function getStatus() @@ -364,7 +457,9 @@ public function getStatus() /** * 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) @@ -376,6 +471,7 @@ public function setStatus($status) /** * Gets workspace_base_url + * * @return string */ public function getWorkspaceBaseUrl() @@ -385,7 +481,9 @@ public function getWorkspaceBaseUrl() /** * Sets workspace_base_url + * * @param string $workspace_base_url The relative URL that may be used to access the workspace. + * * @return $this */ public function setWorkspaceBaseUrl($workspace_base_url) @@ -397,6 +495,7 @@ public function setWorkspaceBaseUrl($workspace_base_url) /** * Gets workspace_description + * * @return string */ public function getWorkspaceDescription() @@ -406,7 +505,9 @@ public function getWorkspaceDescription() /** * Sets workspace_description + * * @param string $workspace_description Text describing the purpose of the workspace. + * * @return $this */ public function setWorkspaceDescription($workspace_description) @@ -418,6 +519,7 @@ public function setWorkspaceDescription($workspace_description) /** * Gets workspace_id + * * @return string */ public function getWorkspaceId() @@ -427,7 +529,9 @@ public function getWorkspaceId() /** * Sets workspace_id + * * @param string $workspace_id The id of the workspace, always populated. + * * @return $this */ public function setWorkspaceId($workspace_id) @@ -439,6 +543,7 @@ public function setWorkspaceId($workspace_id) /** * Gets workspace_name + * * @return string */ public function getWorkspaceName() @@ -448,7 +553,9 @@ public function getWorkspaceName() /** * Sets workspace_name + * * @param string $workspace_name The name of the workspace. + * * @return $this */ public function setWorkspaceName($workspace_name) @@ -460,6 +567,7 @@ public function setWorkspaceName($workspace_name) /** * Gets workspace_uri + * * @return string */ public function getWorkspaceUri() @@ -469,7 +577,9 @@ public function getWorkspaceUri() /** * Sets workspace_uri + * * @param string $workspace_uri The relative URI that may be used to access the workspace. + * * @return $this */ public function setWorkspaceUri($workspace_uri) @@ -480,7 +590,9 @@ public function setWorkspaceUri($workspace_uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -490,7 +602,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -500,8 +614,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -515,7 +631,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -525,16 +643,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/WorkspaceFolderContents.php b/src/Model/WorkspaceFolderContents.php index e74c3c80..080d3dc9 100644 --- a/src/Model/WorkspaceFolderContents.php +++ b/src/Model/WorkspaceFolderContents.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * WorkspaceFolderContents Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class WorkspaceFolderContents implements ArrayAccess +class WorkspaceFolderContents implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'workspaceFolderContents'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -65,13 +68,46 @@ class WorkspaceFolderContents implements ArrayAccess 'workspace_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'folder' => null, + 'items' => null, + 'parent_folders' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null, + 'workspace_id' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -85,9 +121,9 @@ public static function swaggerTypes() 'workspace_id' => 'workspaceId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -101,9 +137,9 @@ public static function swaggerTypes() 'workspace_id' => 'setWorkspaceId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -117,34 +153,63 @@ public static function swaggerTypes() 'workspace_id' => 'getWorkspaceId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -159,30 +224,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -192,7 +259,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -204,6 +273,7 @@ public function setEndPosition($end_position) /** * Gets folder + * * @return \DocuSign\eSign\Model\WorkspaceItem */ public function getFolder() @@ -213,7 +283,9 @@ public function getFolder() /** * Sets folder - * @param \DocuSign\eSign\Model\WorkspaceItem $folder + * + * @param \DocuSign\eSign\Model\WorkspaceItem $folder folder + * * @return $this */ public function setFolder($folder) @@ -225,6 +297,7 @@ public function setFolder($folder) /** * Gets items + * * @return \DocuSign\eSign\Model\WorkspaceItem[] */ public function getItems() @@ -234,7 +307,9 @@ public function getItems() /** * Sets items + * * @param \DocuSign\eSign\Model\WorkspaceItem[] $items + * * @return $this */ public function setItems($items) @@ -246,6 +321,7 @@ public function setItems($items) /** * Gets parent_folders + * * @return \DocuSign\eSign\Model\WorkspaceItem[] */ public function getParentFolders() @@ -255,7 +331,9 @@ public function getParentFolders() /** * Sets parent_folders + * * @param \DocuSign\eSign\Model\WorkspaceItem[] $parent_folders + * * @return $this */ public function setParentFolders($parent_folders) @@ -267,6 +345,7 @@ public function setParentFolders($parent_folders) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -276,7 +355,9 @@ public function getResultSetSize() /** * 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) @@ -288,6 +369,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -297,7 +379,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -309,6 +393,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -318,7 +403,9 @@ public function getTotalSetSize() /** * 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) @@ -330,6 +417,7 @@ public function setTotalSetSize($total_set_size) /** * Gets workspace_id + * * @return string */ public function getWorkspaceId() @@ -339,7 +427,9 @@ public function getWorkspaceId() /** * Sets workspace_id + * * @param string $workspace_id The id of the workspace, always populated. + * * @return $this */ public function setWorkspaceId($workspace_id) @@ -350,7 +440,9 @@ public function setWorkspaceId($workspace_id) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -360,7 +452,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -370,8 +464,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -385,7 +481,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -395,16 +493,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/WorkspaceItem.php b/src/Model/WorkspaceItem.php index 582a254b..321c3a2a 100644 --- a/src/Model/WorkspaceItem.php +++ b/src/Model/WorkspaceItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * WorkspaceItem Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class WorkspaceItem implements ArrayAccess +class WorkspaceItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'workspaceItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -81,13 +84,62 @@ class WorkspaceItem implements ArrayAccess 'user_authorization' => '\DocuSign\eSign\Model\WorkspaceUserAuthorization' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'caller_authorization' => null, + 'content_type' => null, + 'created' => null, + 'created_by_id' => null, + 'created_by_information' => null, + 'extension' => null, + 'file_size' => null, + 'file_uri' => null, + 'id' => null, + 'is_public' => null, + 'last_modified' => null, + 'last_modified_by_id' => null, + 'last_modified_by_information' => null, + 'name' => null, + 'page_count' => null, + 'parent_folder_id' => null, + 'parent_folder_uri' => null, + 'sha256' => null, + 'thumb_height' => null, + 'thumbnail' => null, + 'thumb_width' => null, + 'type' => null, + 'uri' => null, + 'user_authorization' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -117,9 +169,9 @@ public static function swaggerTypes() 'user_authorization' => 'userAuthorization' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -149,9 +201,9 @@ public static function swaggerTypes() 'user_authorization' => 'setUserAuthorization' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -181,34 +233,63 @@ public static function swaggerTypes() 'user_authorization' => 'getUserAuthorization' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -239,30 +320,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets caller_authorization + * * @return \DocuSign\eSign\Model\WorkspaceUserAuthorization */ public function getCallerAuthorization() @@ -272,7 +355,9 @@ public function getCallerAuthorization() /** * Sets caller_authorization - * @param \DocuSign\eSign\Model\WorkspaceUserAuthorization $caller_authorization + * + * @param \DocuSign\eSign\Model\WorkspaceUserAuthorization $caller_authorization caller_authorization + * * @return $this */ public function setCallerAuthorization($caller_authorization) @@ -284,6 +369,7 @@ public function setCallerAuthorization($caller_authorization) /** * Gets content_type + * * @return string */ public function getContentType() @@ -293,7 +379,9 @@ public function getContentType() /** * Sets content_type + * * @param string $content_type + * * @return $this */ public function setContentType($content_type) @@ -305,6 +393,7 @@ public function setContentType($content_type) /** * Gets created + * * @return string */ public function getCreated() @@ -314,7 +403,9 @@ public function getCreated() /** * Sets created + * * @param string $created The UTC DateTime when the workspace item was created. + * * @return $this */ public function setCreated($created) @@ -326,6 +417,7 @@ public function setCreated($created) /** * Gets created_by_id + * * @return string */ public function getCreatedById() @@ -335,7 +427,9 @@ public function getCreatedById() /** * Sets created_by_id + * * @param string $created_by_id + * * @return $this */ public function setCreatedById($created_by_id) @@ -347,6 +441,7 @@ public function setCreatedById($created_by_id) /** * Gets created_by_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getCreatedByInformation() @@ -356,7 +451,9 @@ public function getCreatedByInformation() /** * Sets created_by_information - * @param \DocuSign\eSign\Model\WorkspaceUser $created_by_information + * + * @param \DocuSign\eSign\Model\WorkspaceUser $created_by_information created_by_information + * * @return $this */ public function setCreatedByInformation($created_by_information) @@ -368,6 +465,7 @@ public function setCreatedByInformation($created_by_information) /** * Gets extension + * * @return string */ public function getExtension() @@ -377,7 +475,9 @@ public function getExtension() /** * Sets extension + * * @param string $extension + * * @return $this */ public function setExtension($extension) @@ -389,6 +489,7 @@ public function setExtension($extension) /** * Gets file_size + * * @return string */ public function getFileSize() @@ -398,7 +499,9 @@ public function getFileSize() /** * Sets file_size + * * @param string $file_size + * * @return $this */ public function setFileSize($file_size) @@ -410,6 +513,7 @@ public function setFileSize($file_size) /** * Gets file_uri + * * @return string */ public function getFileUri() @@ -419,7 +523,9 @@ public function getFileUri() /** * Sets file_uri + * * @param string $file_uri + * * @return $this */ public function setFileUri($file_uri) @@ -431,6 +537,7 @@ public function setFileUri($file_uri) /** * Gets id + * * @return string */ public function getId() @@ -440,7 +547,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -452,6 +561,7 @@ public function setId($id) /** * Gets is_public + * * @return string */ public function getIsPublic() @@ -461,7 +571,9 @@ public function getIsPublic() /** * Sets is_public + * * @param string $is_public If true, this supersedes need for bit mask permission with workspaceUserAuthorization + * * @return $this */ public function setIsPublic($is_public) @@ -473,6 +585,7 @@ public function setIsPublic($is_public) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -482,7 +595,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified + * * @return $this */ public function setLastModified($last_modified) @@ -494,6 +609,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_by_id + * * @return string */ public function getLastModifiedById() @@ -503,7 +619,9 @@ public function getLastModifiedById() /** * Sets last_modified_by_id + * * @param string $last_modified_by_id Utc date and time the comment was last updated (can only be done by creator) + * * @return $this */ public function setLastModifiedById($last_modified_by_id) @@ -515,6 +633,7 @@ public function setLastModifiedById($last_modified_by_id) /** * Gets last_modified_by_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getLastModifiedByInformation() @@ -524,7 +643,9 @@ public function getLastModifiedByInformation() /** * Sets last_modified_by_information - * @param \DocuSign\eSign\Model\WorkspaceUser $last_modified_by_information + * + * @param \DocuSign\eSign\Model\WorkspaceUser $last_modified_by_information last_modified_by_information + * * @return $this */ public function setLastModifiedByInformation($last_modified_by_information) @@ -536,6 +657,7 @@ public function setLastModifiedByInformation($last_modified_by_information) /** * Gets name + * * @return string */ public function getName() @@ -545,7 +667,9 @@ public function getName() /** * Sets name + * * @param string $name A simple string description of the item, such as a file name or a folder name. + * * @return $this */ public function setName($name) @@ -557,6 +681,7 @@ public function setName($name) /** * Gets page_count + * * @return string */ public function getPageCount() @@ -566,7 +691,9 @@ public function getPageCount() /** * Sets page_count + * * @param string $page_count + * * @return $this */ public function setPageCount($page_count) @@ -578,6 +705,7 @@ public function setPageCount($page_count) /** * Gets parent_folder_id + * * @return string */ public function getParentFolderId() @@ -587,7 +715,9 @@ public function getParentFolderId() /** * Sets parent_folder_id + * * @param string $parent_folder_id The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder. + * * @return $this */ public function setParentFolderId($parent_folder_id) @@ -599,6 +729,7 @@ public function setParentFolderId($parent_folder_id) /** * Gets parent_folder_uri + * * @return string */ public function getParentFolderUri() @@ -608,7 +739,9 @@ public function getParentFolderUri() /** * Sets parent_folder_uri + * * @param string $parent_folder_uri + * * @return $this */ public function setParentFolderUri($parent_folder_uri) @@ -620,6 +753,7 @@ public function setParentFolderUri($parent_folder_uri) /** * Gets sha256 + * * @return string */ public function getSha256() @@ -629,7 +763,9 @@ public function getSha256() /** * Sets sha256 + * * @param string $sha256 + * * @return $this */ public function setSha256($sha256) @@ -641,6 +777,7 @@ public function setSha256($sha256) /** * Gets thumb_height + * * @return string */ public function getThumbHeight() @@ -650,7 +787,9 @@ public function getThumbHeight() /** * Sets thumb_height + * * @param string $thumb_height + * * @return $this */ public function setThumbHeight($thumb_height) @@ -662,6 +801,7 @@ public function setThumbHeight($thumb_height) /** * Gets thumbnail + * * @return \DocuSign\eSign\Model\Page */ public function getThumbnail() @@ -671,7 +811,9 @@ public function getThumbnail() /** * Sets thumbnail - * @param \DocuSign\eSign\Model\Page $thumbnail + * + * @param \DocuSign\eSign\Model\Page $thumbnail thumbnail + * * @return $this */ public function setThumbnail($thumbnail) @@ -683,6 +825,7 @@ public function setThumbnail($thumbnail) /** * Gets thumb_width + * * @return string */ public function getThumbWidth() @@ -692,7 +835,9 @@ public function getThumbWidth() /** * Sets thumb_width + * * @param string $thumb_width + * * @return $this */ public function setThumbWidth($thumb_width) @@ -704,6 +849,7 @@ public function setThumbWidth($thumb_width) /** * Gets type + * * @return string */ public function getType() @@ -713,7 +859,9 @@ public function getType() /** * Sets type + * * @param string $type The type of the workspace item. Valid values are file, folder. + * * @return $this */ public function setType($type) @@ -725,6 +873,7 @@ public function setType($type) /** * Gets uri + * * @return string */ public function getUri() @@ -734,7 +883,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -746,6 +897,7 @@ public function setUri($uri) /** * Gets user_authorization + * * @return \DocuSign\eSign\Model\WorkspaceUserAuthorization */ public function getUserAuthorization() @@ -755,7 +907,9 @@ public function getUserAuthorization() /** * Sets user_authorization - * @param \DocuSign\eSign\Model\WorkspaceUserAuthorization $user_authorization + * + * @param \DocuSign\eSign\Model\WorkspaceUserAuthorization $user_authorization user_authorization + * * @return $this */ public function setUserAuthorization($user_authorization) @@ -766,7 +920,9 @@ public function setUserAuthorization($user_authorization) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -776,7 +932,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -786,8 +944,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -801,7 +961,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -811,16 +973,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/WorkspaceItemList.php b/src/Model/WorkspaceItemList.php index b51e696e..3fa53743 100644 --- a/src/Model/WorkspaceItemList.php +++ b/src/Model/WorkspaceItemList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * WorkspaceItemList Class Doc Comment @@ -40,83 +41,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class WorkspaceItemList implements ArrayAccess +class WorkspaceItemList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'workspaceItemList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'items' => '\DocuSign\eSign\Model\WorkspaceItem[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'items' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'items' => 'items' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'items' => 'setItems' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'items' => 'getItems' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -124,30 +182,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets items + * * @return \DocuSign\eSign\Model\WorkspaceItem[] */ public function getItems() @@ -157,7 +217,9 @@ public function getItems() /** * Sets items + * * @param \DocuSign\eSign\Model\WorkspaceItem[] $items + * * @return $this */ public function setItems($items) @@ -168,7 +230,9 @@ public function setItems($items) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -178,7 +242,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -188,8 +254,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -203,7 +271,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -213,16 +283,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/WorkspaceList.php b/src/Model/WorkspaceList.php index 3cc9e153..5fc8ba56 100644 --- a/src/Model/WorkspaceList.php +++ b/src/Model/WorkspaceList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * WorkspaceList Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class WorkspaceList implements ArrayAccess +class WorkspaceList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'workspaceList'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -62,13 +65,43 @@ class WorkspaceList implements ArrayAccess 'workspaces' => '\DocuSign\eSign\Model\Workspace[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'result_set_size' => null, + 'start_position' => null, + 'total_set_size' => null, + 'workspaces' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -79,9 +112,9 @@ public static function swaggerTypes() 'workspaces' => 'workspaces' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -92,9 +125,9 @@ public static function swaggerTypes() 'workspaces' => 'setWorkspaces' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -105,34 +138,63 @@ public static function swaggerTypes() 'workspaces' => 'getWorkspaces' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -144,30 +206,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -177,7 +241,9 @@ public function getEndPosition() /** * Sets end_position + * * @param string $end_position The last position in the result set. + * * @return $this */ public function setEndPosition($end_position) @@ -189,6 +255,7 @@ public function setEndPosition($end_position) /** * Gets result_set_size + * * @return string */ public function getResultSetSize() @@ -198,7 +265,9 @@ public function getResultSetSize() /** * 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) @@ -210,6 +279,7 @@ public function setResultSetSize($result_set_size) /** * Gets start_position + * * @return string */ public function getStartPosition() @@ -219,7 +289,9 @@ public function getStartPosition() /** * Sets start_position + * * @param string $start_position Starting position of the current result set. + * * @return $this */ public function setStartPosition($start_position) @@ -231,6 +303,7 @@ public function setStartPosition($start_position) /** * Gets total_set_size + * * @return string */ public function getTotalSetSize() @@ -240,7 +313,9 @@ public function getTotalSetSize() /** * 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) @@ -252,6 +327,7 @@ public function setTotalSetSize($total_set_size) /** * Gets workspaces + * * @return \DocuSign\eSign\Model\Workspace[] */ public function getWorkspaces() @@ -261,7 +337,9 @@ public function getWorkspaces() /** * Sets workspaces + * * @param \DocuSign\eSign\Model\Workspace[] $workspaces A list of workspaces. + * * @return $this */ public function setWorkspaces($workspaces) @@ -272,7 +350,9 @@ public function setWorkspaces($workspaces) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -282,7 +362,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -292,8 +374,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -307,7 +391,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -317,16 +403,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/WorkspaceSettings.php b/src/Model/WorkspaceSettings.php index b366f619..7c12e870 100644 --- a/src/Model/WorkspaceSettings.php +++ b/src/Model/WorkspaceSettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * WorkspaceSettings Class Doc Comment @@ -39,83 +40,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class WorkspaceSettings implements ArrayAccess +class WorkspaceSettings implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'workspaceSettings'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'comments_allowed' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'comments_allowed' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'comments_allowed' => 'commentsAllowed' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'comments_allowed' => 'setCommentsAllowed' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'comments_allowed' => 'getCommentsAllowed' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -123,30 +181,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets comments_allowed + * * @return string */ public function getCommentsAllowed() @@ -156,7 +216,9 @@ public function getCommentsAllowed() /** * Sets comments_allowed + * * @param string $comments_allowed + * * @return $this */ public function setCommentsAllowed($comments_allowed) @@ -167,7 +229,9 @@ public function setCommentsAllowed($comments_allowed) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -177,7 +241,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -187,8 +253,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -202,7 +270,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -212,16 +282,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/WorkspaceUser.php b/src/Model/WorkspaceUser.php index 78f12765..9795997e 100644 --- a/src/Model/WorkspaceUser.php +++ b/src/Model/WorkspaceUser.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * WorkspaceUser Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class WorkspaceUser implements ArrayAccess +class WorkspaceUser implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'workspaceUser'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -76,13 +79,57 @@ class WorkspaceUser implements ArrayAccess 'workspace_user_uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_id' => null, + 'account_name' => null, + 'active_since' => null, + 'created' => null, + 'created_by_id' => null, + 'email' => null, + 'error_details' => null, + 'invitation_email_blurb' => null, + 'invitation_email_subject' => null, + 'last_modified' => null, + 'last_modified_by_id' => null, + 'status' => null, + 'type' => null, + 'user_id' => null, + 'user_name' => null, + 'workspace_id' => null, + 'workspace_user_base_url' => null, + 'workspace_user_id' => null, + 'workspace_user_uri' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -107,9 +154,9 @@ public static function swaggerTypes() 'workspace_user_uri' => 'workspaceUserUri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -134,9 +181,9 @@ public static function swaggerTypes() 'workspace_user_uri' => 'setWorkspaceUserUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -161,34 +208,63 @@ public static function swaggerTypes() 'workspace_user_uri' => 'getWorkspaceUserUri' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -214,30 +290,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets account_id + * * @return string */ public function getAccountId() @@ -247,7 +325,9 @@ public function getAccountId() /** * Sets account_id + * * @param string $account_id The account ID associated with the envelope. + * * @return $this */ public function setAccountId($account_id) @@ -259,6 +339,7 @@ public function setAccountId($account_id) /** * Gets account_name + * * @return string */ public function getAccountName() @@ -268,7 +349,9 @@ public function getAccountName() /** * Sets account_name + * * @param string $account_name The name of the account that the workspace user belongs to. + * * @return $this */ public function setAccountName($account_name) @@ -280,6 +363,7 @@ public function setAccountName($account_name) /** * Gets active_since + * * @return string */ public function getActiveSince() @@ -289,7 +373,9 @@ public function getActiveSince() /** * Sets active_since + * * @param string $active_since + * * @return $this */ public function setActiveSince($active_since) @@ -301,6 +387,7 @@ public function setActiveSince($active_since) /** * Gets created + * * @return string */ public function getCreated() @@ -310,7 +397,9 @@ public function getCreated() /** * Sets created + * * @param string $created The UTC DateTime when the workspace user was created. + * * @return $this */ public function setCreated($created) @@ -322,6 +411,7 @@ public function setCreated($created) /** * Gets created_by_id + * * @return string */ public function getCreatedById() @@ -331,7 +421,9 @@ public function getCreatedById() /** * Sets created_by_id + * * @param string $created_by_id + * * @return $this */ public function setCreatedById($created_by_id) @@ -343,6 +435,7 @@ public function setCreatedById($created_by_id) /** * Gets email + * * @return string */ public function getEmail() @@ -352,7 +445,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -364,6 +459,7 @@ public function setEmail($email) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -373,7 +469,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -385,6 +483,7 @@ public function setErrorDetails($error_details) /** * Gets invitation_email_blurb + * * @return string */ public function getInvitationEmailBlurb() @@ -394,7 +493,9 @@ public function getInvitationEmailBlurb() /** * Sets invitation_email_blurb + * * @param string $invitation_email_blurb + * * @return $this */ public function setInvitationEmailBlurb($invitation_email_blurb) @@ -406,6 +507,7 @@ public function setInvitationEmailBlurb($invitation_email_blurb) /** * Gets invitation_email_subject + * * @return string */ public function getInvitationEmailSubject() @@ -415,7 +517,9 @@ public function getInvitationEmailSubject() /** * Sets invitation_email_subject + * * @param string $invitation_email_subject + * * @return $this */ public function setInvitationEmailSubject($invitation_email_subject) @@ -427,6 +531,7 @@ public function setInvitationEmailSubject($invitation_email_subject) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -436,7 +541,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified Utc date and time the comment was last updated (can only be done by creator.) + * * @return $this */ public function setLastModified($last_modified) @@ -448,6 +555,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_by_id + * * @return string */ public function getLastModifiedById() @@ -457,7 +565,9 @@ public function getLastModifiedById() /** * Sets last_modified_by_id + * * @param string $last_modified_by_id + * * @return $this */ public function setLastModifiedById($last_modified_by_id) @@ -469,6 +579,7 @@ public function setLastModifiedById($last_modified_by_id) /** * Gets status + * * @return string */ public function getStatus() @@ -478,7 +589,9 @@ public function getStatus() /** * 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) @@ -490,6 +603,7 @@ public function setStatus($status) /** * Gets type + * * @return string */ public function getType() @@ -499,7 +613,9 @@ public function getType() /** * Sets type + * * @param string $type Type of the user. Valid values: type_owner, type_participant. + * * @return $this */ public function setType($type) @@ -511,6 +627,7 @@ public function setType($type) /** * Gets user_id + * * @return string */ public function getUserId() @@ -520,7 +637,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -532,6 +651,7 @@ public function setUserId($user_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -541,7 +661,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -553,6 +675,7 @@ public function setUserName($user_name) /** * Gets workspace_id + * * @return string */ public function getWorkspaceId() @@ -562,7 +685,9 @@ public function getWorkspaceId() /** * Sets workspace_id + * * @param string $workspace_id + * * @return $this */ public function setWorkspaceId($workspace_id) @@ -574,6 +699,7 @@ public function setWorkspaceId($workspace_id) /** * Gets workspace_user_base_url + * * @return string */ public function getWorkspaceUserBaseUrl() @@ -583,7 +709,9 @@ public function getWorkspaceUserBaseUrl() /** * Sets workspace_user_base_url + * * @param string $workspace_user_base_url The relative URI that may be used to access a workspace user. + * * @return $this */ public function setWorkspaceUserBaseUrl($workspace_user_base_url) @@ -595,6 +723,7 @@ public function setWorkspaceUserBaseUrl($workspace_user_base_url) /** * Gets workspace_user_id + * * @return string */ public function getWorkspaceUserId() @@ -604,7 +733,9 @@ public function getWorkspaceUserId() /** * Sets workspace_user_id + * * @param string $workspace_user_id + * * @return $this */ public function setWorkspaceUserId($workspace_user_id) @@ -616,6 +747,7 @@ public function setWorkspaceUserId($workspace_user_id) /** * Gets workspace_user_uri + * * @return string */ public function getWorkspaceUserUri() @@ -625,7 +757,9 @@ public function getWorkspaceUserUri() /** * Sets workspace_user_uri + * * @param string $workspace_user_uri + * * @return $this */ public function setWorkspaceUserUri($workspace_user_uri) @@ -636,7 +770,9 @@ public function setWorkspaceUserUri($workspace_user_uri) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -646,7 +782,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -656,8 +794,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -671,7 +811,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -681,16 +823,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/WorkspaceUserAuthorization.php b/src/Model/WorkspaceUserAuthorization.php index 77bd7216..1babe2e5 100644 --- a/src/Model/WorkspaceUserAuthorization.php +++ b/src/Model/WorkspaceUserAuthorization.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * WorkspaceUserAuthorization Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class WorkspaceUserAuthorization implements ArrayAccess +class WorkspaceUserAuthorization implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'workspaceUserAuthorization'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -68,13 +71,49 @@ class WorkspaceUserAuthorization implements ArrayAccess 'workspace_user_information' => '\DocuSign\eSign\Model\WorkspaceUser' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'can_delete' => null, + 'can_move' => null, + 'can_transact' => null, + 'can_view' => null, + 'created' => null, + 'created_by_id' => null, + 'error_details' => null, + 'modified' => null, + 'modified_by_id' => null, + 'workspace_user_id' => null, + 'workspace_user_information' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -91,9 +130,9 @@ public static function swaggerTypes() 'workspace_user_information' => 'workspaceUserInformation' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -110,9 +149,9 @@ public static function swaggerTypes() 'workspace_user_information' => 'setWorkspaceUserInformation' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -129,34 +168,63 @@ public static function swaggerTypes() 'workspace_user_information' => 'getWorkspaceUserInformation' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -174,30 +242,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets can_delete + * * @return string */ public function getCanDelete() @@ -207,7 +277,9 @@ public function getCanDelete() /** * Sets can_delete + * * @param string $can_delete + * * @return $this */ public function setCanDelete($can_delete) @@ -219,6 +291,7 @@ public function setCanDelete($can_delete) /** * Gets can_move + * * @return string */ public function getCanMove() @@ -228,7 +301,9 @@ public function getCanMove() /** * Sets can_move + * * @param string $can_move + * * @return $this */ public function setCanMove($can_move) @@ -240,6 +315,7 @@ public function setCanMove($can_move) /** * Gets can_transact + * * @return string */ public function getCanTransact() @@ -249,7 +325,9 @@ public function getCanTransact() /** * Sets can_transact + * * @param string $can_transact + * * @return $this */ public function setCanTransact($can_transact) @@ -261,6 +339,7 @@ public function setCanTransact($can_transact) /** * Gets can_view + * * @return string */ public function getCanView() @@ -270,7 +349,9 @@ public function getCanView() /** * Sets can_view + * * @param string $can_view + * * @return $this */ public function setCanView($can_view) @@ -282,6 +363,7 @@ public function setCanView($can_view) /** * Gets created + * * @return string */ public function getCreated() @@ -291,7 +373,9 @@ public function getCreated() /** * Sets created + * * @param string $created The UTC DateTime when the workspace user authorization was created. + * * @return $this */ public function setCreated($created) @@ -303,6 +387,7 @@ public function setCreated($created) /** * Gets created_by_id + * * @return string */ public function getCreatedById() @@ -312,7 +397,9 @@ public function getCreatedById() /** * Sets created_by_id + * * @param string $created_by_id + * * @return $this */ public function setCreatedById($created_by_id) @@ -324,6 +411,7 @@ public function setCreatedById($created_by_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -333,7 +421,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -345,6 +435,7 @@ public function setErrorDetails($error_details) /** * Gets modified + * * @return string */ public function getModified() @@ -354,7 +445,9 @@ public function getModified() /** * Sets modified + * * @param string $modified + * * @return $this */ public function setModified($modified) @@ -366,6 +459,7 @@ public function setModified($modified) /** * Gets modified_by_id + * * @return string */ public function getModifiedById() @@ -375,7 +469,9 @@ public function getModifiedById() /** * Sets modified_by_id + * * @param string $modified_by_id + * * @return $this */ public function setModifiedById($modified_by_id) @@ -387,6 +483,7 @@ public function setModifiedById($modified_by_id) /** * Gets workspace_user_id + * * @return string */ public function getWorkspaceUserId() @@ -396,7 +493,9 @@ public function getWorkspaceUserId() /** * Sets workspace_user_id + * * @param string $workspace_user_id + * * @return $this */ public function setWorkspaceUserId($workspace_user_id) @@ -408,6 +507,7 @@ public function setWorkspaceUserId($workspace_user_id) /** * Gets workspace_user_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getWorkspaceUserInformation() @@ -417,7 +517,9 @@ public function getWorkspaceUserInformation() /** * Sets workspace_user_information - * @param \DocuSign\eSign\Model\WorkspaceUser $workspace_user_information + * + * @param \DocuSign\eSign\Model\WorkspaceUser $workspace_user_information workspace_user_information + * * @return $this */ public function setWorkspaceUserInformation($workspace_user_information) @@ -428,7 +530,9 @@ public function setWorkspaceUserInformation($workspace_user_information) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -438,7 +542,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -448,8 +554,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -463,7 +571,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -473,16 +583,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/Zip.php b/src/Model/Zip.php index 2ea96cc8..402e0c42 100644 --- a/src/Model/Zip.php +++ b/src/Model/Zip.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * Zip Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class Zip implements ArrayAccess +class Zip implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'zip'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -169,13 +172,151 @@ class Zip implements ArrayAccess 'y_position_metadata' => '\DocuSign\eSign\Model\PropertyMetadata' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_allow_white_space_in_characters' => null, + 'anchor_allow_white_space_in_characters_metadata' => null, + 'anchor_case_sensitive' => null, + 'anchor_case_sensitive_metadata' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_horizontal_alignment_metadata' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_ignore_if_not_present_metadata' => null, + 'anchor_match_whole_word' => null, + 'anchor_match_whole_word_metadata' => null, + 'anchor_string' => null, + 'anchor_string_metadata' => null, + 'anchor_tab_processor_version' => null, + 'anchor_tab_processor_version_metadata' => null, + 'anchor_units' => null, + 'anchor_units_metadata' => null, + 'anchor_x_offset' => null, + 'anchor_x_offset_metadata' => null, + 'anchor_y_offset' => null, + 'anchor_y_offset_metadata' => null, + 'bold' => null, + 'bold_metadata' => null, + 'conceal_value_on_document' => null, + 'conceal_value_on_document_metadata' => null, + 'conditional_parent_label' => null, + 'conditional_parent_label_metadata' => null, + 'conditional_parent_value' => null, + 'conditional_parent_value_metadata' => null, + 'custom_tab_id' => null, + 'custom_tab_id_metadata' => null, + 'disable_auto_size' => null, + 'disable_auto_size_metadata' => null, + 'document_id' => null, + 'document_id_metadata' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_color_metadata' => null, + 'font_metadata' => null, + 'font_size' => null, + 'font_size_metadata' => null, + 'form_order' => null, + 'form_order_metadata' => null, + 'form_page_label' => null, + 'form_page_label_metadata' => null, + 'form_page_number' => null, + 'form_page_number_metadata' => null, + 'height' => null, + 'height_metadata' => null, + 'italic' => null, + 'italic_metadata' => null, + 'locale_policy' => null, + 'locked' => null, + 'locked_metadata' => null, + 'max_length' => null, + 'max_length_metadata' => null, + 'merge_field' => null, + 'merge_field_xml' => null, + 'name' => null, + 'name_metadata' => null, + 'original_value' => null, + 'original_value_metadata' => null, + 'page_number' => null, + 'page_number_metadata' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_id_guid_metadata' => null, + 'recipient_id_metadata' => null, + 'require_all' => null, + 'require_all_metadata' => null, + 'required' => null, + 'required_metadata' => null, + 'require_initial_on_shared_change' => null, + 'require_initial_on_shared_change_metadata' => null, + 'sender_required' => null, + 'sender_required_metadata' => null, + 'shared' => null, + 'shared_metadata' => null, + 'smart_contract_information' => null, + 'status' => null, + 'status_metadata' => null, + 'tab_group_labels' => null, + 'tab_group_labels_metadata' => null, + 'tab_id' => null, + 'tab_id_metadata' => null, + 'tab_label' => null, + 'tab_label_metadata' => null, + 'tab_order' => null, + 'tab_order_metadata' => null, + 'tab_type' => null, + 'tab_type_metadata' => null, + 'template_locked' => null, + 'template_locked_metadata' => null, + 'template_required' => null, + 'template_required_metadata' => null, + 'tooltip' => null, + 'tool_tip_metadata' => null, + 'underline' => null, + 'underline_metadata' => null, + 'use_dash4' => null, + 'use_dash4_metadata' => null, + 'validation_message' => null, + 'validation_message_metadata' => null, + 'validation_pattern' => null, + 'validation_pattern_metadata' => null, + 'value' => null, + 'value_metadata' => null, + 'width' => null, + 'width_metadata' => null, + 'x_position' => null, + 'x_position_metadata' => null, + 'y_position' => null, + 'y_position_metadata' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ @@ -294,9 +435,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'yPositionMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -415,9 +556,9 @@ public static function swaggerTypes() 'y_position_metadata' => 'setYPositionMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -536,34 +677,63 @@ public static function swaggerTypes() 'y_position_metadata' => 'getYPositionMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -683,30 +853,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets anchor_allow_white_space_in_characters + * * @return string */ public function getAnchorAllowWhiteSpaceInCharacters() @@ -716,7 +888,9 @@ public function getAnchorAllowWhiteSpaceInCharacters() /** * Sets anchor_allow_white_space_in_characters + * * @param string $anchor_allow_white_space_in_characters + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_in_characters) @@ -728,6 +902,7 @@ public function setAnchorAllowWhiteSpaceInCharacters($anchor_allow_white_space_i /** * Gets anchor_allow_white_space_in_characters_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorAllowWhiteSpaceInCharactersMetadata() @@ -737,7 +912,9 @@ public function getAnchorAllowWhiteSpaceInCharactersMetadata() /** * Sets anchor_allow_white_space_in_characters_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_allow_white_space_in_characters_metadata anchor_allow_white_space_in_characters_metadata + * * @return $this */ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white_space_in_characters_metadata) @@ -749,6 +926,7 @@ public function setAnchorAllowWhiteSpaceInCharactersMetadata($anchor_allow_white /** * Gets anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -758,7 +936,9 @@ public function getAnchorCaseSensitive() /** * 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) @@ -770,6 +950,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_case_sensitive_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorCaseSensitiveMetadata() @@ -779,7 +960,9 @@ public function getAnchorCaseSensitiveMetadata() /** * Sets anchor_case_sensitive_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_case_sensitive_metadata anchor_case_sensitive_metadata + * * @return $this */ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) @@ -791,6 +974,7 @@ public function setAnchorCaseSensitiveMetadata($anchor_case_sensitive_metadata) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -800,7 +984,9 @@ public function getAnchorHorizontalAlignment() /** * 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) @@ -812,6 +998,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_horizontal_alignment_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorHorizontalAlignmentMetadata() @@ -821,7 +1008,9 @@ public function getAnchorHorizontalAlignmentMetadata() /** * Sets anchor_horizontal_alignment_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_horizontal_alignment_metadata anchor_horizontal_alignment_metadata + * * @return $this */ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignment_metadata) @@ -833,6 +1022,7 @@ public function setAnchorHorizontalAlignmentMetadata($anchor_horizontal_alignmen /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -842,7 +1032,9 @@ public function getAnchorIgnoreIfNotPresent() /** * 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) @@ -854,6 +1046,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_ignore_if_not_present_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorIgnoreIfNotPresentMetadata() @@ -863,7 +1056,9 @@ public function getAnchorIgnoreIfNotPresentMetadata() /** * Sets anchor_ignore_if_not_present_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_ignore_if_not_present_metadata anchor_ignore_if_not_present_metadata + * * @return $this */ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_present_metadata) @@ -875,6 +1070,7 @@ public function setAnchorIgnoreIfNotPresentMetadata($anchor_ignore_if_not_presen /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -884,7 +1080,9 @@ public function getAnchorMatchWholeWord() /** * 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) @@ -896,6 +1094,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_match_whole_word_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorMatchWholeWordMetadata() @@ -905,7 +1104,9 @@ public function getAnchorMatchWholeWordMetadata() /** * Sets anchor_match_whole_word_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_match_whole_word_metadata anchor_match_whole_word_metadata + * * @return $this */ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadata) @@ -917,6 +1118,7 @@ public function setAnchorMatchWholeWordMetadata($anchor_match_whole_word_metadat /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -926,7 +1128,9 @@ public function getAnchorString() /** * Sets anchor_string + * * @param string $anchor_string Anchor text information for a radio button. + * * @return $this */ public function setAnchorString($anchor_string) @@ -938,6 +1142,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_string_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorStringMetadata() @@ -947,7 +1152,9 @@ public function getAnchorStringMetadata() /** * Sets anchor_string_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_string_metadata anchor_string_metadata + * * @return $this */ public function setAnchorStringMetadata($anchor_string_metadata) @@ -959,6 +1166,7 @@ public function setAnchorStringMetadata($anchor_string_metadata) /** * Gets anchor_tab_processor_version + * * @return string */ public function getAnchorTabProcessorVersion() @@ -968,7 +1176,9 @@ public function getAnchorTabProcessorVersion() /** * Sets anchor_tab_processor_version + * * @param string $anchor_tab_processor_version + * * @return $this */ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) @@ -980,6 +1190,7 @@ public function setAnchorTabProcessorVersion($anchor_tab_processor_version) /** * Gets anchor_tab_processor_version_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorTabProcessorVersionMetadata() @@ -989,7 +1200,9 @@ public function getAnchorTabProcessorVersionMetadata() /** * Sets anchor_tab_processor_version_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_tab_processor_version_metadata anchor_tab_processor_version_metadata + * * @return $this */ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_version_metadata) @@ -1001,6 +1214,7 @@ public function setAnchorTabProcessorVersionMetadata($anchor_tab_processor_versi /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -1010,7 +1224,9 @@ public function getAnchorUnits() /** * 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) @@ -1022,6 +1238,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_units_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorUnitsMetadata() @@ -1031,7 +1248,9 @@ public function getAnchorUnitsMetadata() /** * Sets anchor_units_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_units_metadata anchor_units_metadata + * * @return $this */ public function setAnchorUnitsMetadata($anchor_units_metadata) @@ -1043,6 +1262,7 @@ public function setAnchorUnitsMetadata($anchor_units_metadata) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -1052,7 +1272,9 @@ public function getAnchorXOffset() /** * 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) @@ -1064,6 +1286,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_x_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorXOffsetMetadata() @@ -1073,7 +1296,9 @@ public function getAnchorXOffsetMetadata() /** * Sets anchor_x_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_x_offset_metadata anchor_x_offset_metadata + * * @return $this */ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) @@ -1085,6 +1310,7 @@ public function setAnchorXOffsetMetadata($anchor_x_offset_metadata) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -1094,7 +1320,9 @@ public function getAnchorYOffset() /** * 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) @@ -1106,6 +1334,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets anchor_y_offset_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getAnchorYOffsetMetadata() @@ -1115,7 +1344,9 @@ public function getAnchorYOffsetMetadata() /** * Sets anchor_y_offset_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $anchor_y_offset_metadata anchor_y_offset_metadata + * * @return $this */ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) @@ -1127,6 +1358,7 @@ public function setAnchorYOffsetMetadata($anchor_y_offset_metadata) /** * Gets bold + * * @return string */ public function getBold() @@ -1136,7 +1368,9 @@ public function getBold() /** * Sets bold + * * @param string $bold When set to **true**, the information in the tab is bold. + * * @return $this */ public function setBold($bold) @@ -1148,6 +1382,7 @@ public function setBold($bold) /** * Gets bold_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getBoldMetadata() @@ -1157,7 +1392,9 @@ public function getBoldMetadata() /** * Sets bold_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $bold_metadata bold_metadata + * * @return $this */ public function setBoldMetadata($bold_metadata) @@ -1169,6 +1406,7 @@ public function setBoldMetadata($bold_metadata) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -1178,7 +1416,9 @@ public function getConcealValueOnDocument() /** * Sets conceal_value_on_document + * * @param string $conceal_value_on_document When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. + * * @return $this */ public function setConcealValueOnDocument($conceal_value_on_document) @@ -1190,6 +1430,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conceal_value_on_document_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConcealValueOnDocumentMetadata() @@ -1199,7 +1440,9 @@ public function getConcealValueOnDocumentMetadata() /** * Sets conceal_value_on_document_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conceal_value_on_document_metadata conceal_value_on_document_metadata + * * @return $this */ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_metadata) @@ -1211,6 +1454,7 @@ public function setConcealValueOnDocumentMetadata($conceal_value_on_document_met /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -1220,7 +1464,9 @@ public function getConditionalParentLabel() /** * 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) @@ -1232,6 +1478,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentLabelMetadata() @@ -1241,7 +1488,9 @@ public function getConditionalParentLabelMetadata() /** * Sets conditional_parent_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_label_metadata conditional_parent_label_metadata + * * @return $this */ public function setConditionalParentLabelMetadata($conditional_parent_label_metadata) @@ -1253,6 +1502,7 @@ public function setConditionalParentLabelMetadata($conditional_parent_label_meta /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -1262,7 +1512,9 @@ public function getConditionalParentValue() /** * 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) @@ -1274,6 +1526,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets conditional_parent_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getConditionalParentValueMetadata() @@ -1283,7 +1536,9 @@ public function getConditionalParentValueMetadata() /** * Sets conditional_parent_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $conditional_parent_value_metadata conditional_parent_value_metadata + * * @return $this */ public function setConditionalParentValueMetadata($conditional_parent_value_metadata) @@ -1295,6 +1550,7 @@ public function setConditionalParentValueMetadata($conditional_parent_value_meta /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -1304,7 +1560,9 @@ public function getCustomTabId() /** * 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) @@ -1316,6 +1574,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets custom_tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getCustomTabIdMetadata() @@ -1325,7 +1584,9 @@ public function getCustomTabIdMetadata() /** * Sets custom_tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $custom_tab_id_metadata custom_tab_id_metadata + * * @return $this */ public function setCustomTabIdMetadata($custom_tab_id_metadata) @@ -1337,6 +1598,7 @@ public function setCustomTabIdMetadata($custom_tab_id_metadata) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -1346,7 +1608,9 @@ public function getDisableAutoSize() /** * Sets disable_auto_size + * * @param string $disable_auto_size When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. + * * @return $this */ public function setDisableAutoSize($disable_auto_size) @@ -1358,6 +1622,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets disable_auto_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDisableAutoSizeMetadata() @@ -1367,7 +1632,9 @@ public function getDisableAutoSizeMetadata() /** * Sets disable_auto_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $disable_auto_size_metadata disable_auto_size_metadata + * * @return $this */ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) @@ -1379,6 +1646,7 @@ public function setDisableAutoSizeMetadata($disable_auto_size_metadata) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -1388,7 +1656,9 @@ public function getDocumentId() /** * 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) @@ -1400,6 +1670,7 @@ public function setDocumentId($document_id) /** * Gets document_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getDocumentIdMetadata() @@ -1409,7 +1680,9 @@ public function getDocumentIdMetadata() /** * Sets document_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $document_id_metadata document_id_metadata + * * @return $this */ public function setDocumentIdMetadata($document_id_metadata) @@ -1421,6 +1694,7 @@ public function setDocumentIdMetadata($document_id_metadata) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -1430,7 +1704,9 @@ public function getErrorDetails() /** * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * + * @param \DocuSign\eSign\Model\ErrorDetails $error_details error_details + * * @return $this */ public function setErrorDetails($error_details) @@ -1442,6 +1718,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -1451,7 +1728,9 @@ public function getFont() /** * 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) @@ -1463,6 +1742,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -1472,7 +1752,9 @@ public function getFontColor() /** * 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) @@ -1484,6 +1766,7 @@ public function setFontColor($font_color) /** * Gets font_color_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontColorMetadata() @@ -1493,7 +1776,9 @@ public function getFontColorMetadata() /** * Sets font_color_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_color_metadata font_color_metadata + * * @return $this */ public function setFontColorMetadata($font_color_metadata) @@ -1505,6 +1790,7 @@ public function setFontColorMetadata($font_color_metadata) /** * Gets font_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontMetadata() @@ -1514,7 +1800,9 @@ public function getFontMetadata() /** * Sets font_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_metadata font_metadata + * * @return $this */ public function setFontMetadata($font_metadata) @@ -1526,6 +1814,7 @@ public function setFontMetadata($font_metadata) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -1535,7 +1824,9 @@ public function getFontSize() /** * 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) @@ -1547,6 +1838,7 @@ public function setFontSize($font_size) /** * Gets font_size_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFontSizeMetadata() @@ -1556,7 +1848,9 @@ public function getFontSizeMetadata() /** * Sets font_size_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $font_size_metadata font_size_metadata + * * @return $this */ public function setFontSizeMetadata($font_size_metadata) @@ -1568,6 +1862,7 @@ public function setFontSizeMetadata($font_size_metadata) /** * Gets form_order + * * @return string */ public function getFormOrder() @@ -1577,7 +1872,9 @@ public function getFormOrder() /** * Sets form_order + * * @param string $form_order + * * @return $this */ public function setFormOrder($form_order) @@ -1589,6 +1886,7 @@ public function setFormOrder($form_order) /** * Gets form_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormOrderMetadata() @@ -1598,7 +1896,9 @@ public function getFormOrderMetadata() /** * Sets form_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_order_metadata form_order_metadata + * * @return $this */ public function setFormOrderMetadata($form_order_metadata) @@ -1610,6 +1910,7 @@ public function setFormOrderMetadata($form_order_metadata) /** * Gets form_page_label + * * @return string */ public function getFormPageLabel() @@ -1619,7 +1920,9 @@ public function getFormPageLabel() /** * Sets form_page_label + * * @param string $form_page_label + * * @return $this */ public function setFormPageLabel($form_page_label) @@ -1631,6 +1934,7 @@ public function setFormPageLabel($form_page_label) /** * Gets form_page_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageLabelMetadata() @@ -1640,7 +1944,9 @@ public function getFormPageLabelMetadata() /** * Sets form_page_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_label_metadata form_page_label_metadata + * * @return $this */ public function setFormPageLabelMetadata($form_page_label_metadata) @@ -1652,6 +1958,7 @@ public function setFormPageLabelMetadata($form_page_label_metadata) /** * Gets form_page_number + * * @return string */ public function getFormPageNumber() @@ -1661,7 +1968,9 @@ public function getFormPageNumber() /** * Sets form_page_number + * * @param string $form_page_number + * * @return $this */ public function setFormPageNumber($form_page_number) @@ -1673,6 +1982,7 @@ public function setFormPageNumber($form_page_number) /** * Gets form_page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getFormPageNumberMetadata() @@ -1682,7 +1992,9 @@ public function getFormPageNumberMetadata() /** * Sets form_page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $form_page_number_metadata form_page_number_metadata + * * @return $this */ public function setFormPageNumberMetadata($form_page_number_metadata) @@ -1694,6 +2006,7 @@ public function setFormPageNumberMetadata($form_page_number_metadata) /** * Gets height + * * @return string */ public function getHeight() @@ -1703,7 +2016,9 @@ public function getHeight() /** * Sets height + * * @param string $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -1715,6 +2030,7 @@ public function setHeight($height) /** * Gets height_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getHeightMetadata() @@ -1724,7 +2040,9 @@ public function getHeightMetadata() /** * Sets height_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $height_metadata height_metadata + * * @return $this */ public function setHeightMetadata($height_metadata) @@ -1736,6 +2054,7 @@ public function setHeightMetadata($height_metadata) /** * Gets italic + * * @return string */ public function getItalic() @@ -1745,7 +2064,9 @@ public function getItalic() /** * Sets italic + * * @param string $italic When set to **true**, the information in the tab is italic. + * * @return $this */ public function setItalic($italic) @@ -1757,6 +2078,7 @@ public function setItalic($italic) /** * Gets italic_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getItalicMetadata() @@ -1766,7 +2088,9 @@ public function getItalicMetadata() /** * Sets italic_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $italic_metadata italic_metadata + * * @return $this */ public function setItalicMetadata($italic_metadata) @@ -1778,6 +2102,7 @@ public function setItalicMetadata($italic_metadata) /** * Gets locale_policy + * * @return \DocuSign\eSign\Model\LocalePolicyTab */ public function getLocalePolicy() @@ -1787,7 +2112,9 @@ public function getLocalePolicy() /** * Sets locale_policy - * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy + * + * @param \DocuSign\eSign\Model\LocalePolicyTab $locale_policy locale_policy + * * @return $this */ public function setLocalePolicy($locale_policy) @@ -1799,6 +2126,7 @@ public function setLocalePolicy($locale_policy) /** * Gets locked + * * @return string */ public function getLocked() @@ -1808,7 +2136,9 @@ public function getLocked() /** * 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) @@ -1820,6 +2150,7 @@ public function setLocked($locked) /** * Gets locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getLockedMetadata() @@ -1829,7 +2160,9 @@ public function getLockedMetadata() /** * Sets locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $locked_metadata locked_metadata + * * @return $this */ public function setLockedMetadata($locked_metadata) @@ -1841,6 +2174,7 @@ public function setLockedMetadata($locked_metadata) /** * Gets max_length + * * @return string */ public function getMaxLength() @@ -1850,7 +2184,9 @@ public function getMaxLength() /** * Sets max_length + * * @param string $max_length An optional value that describes the maximum length of the property when the property is a string. + * * @return $this */ public function setMaxLength($max_length) @@ -1862,6 +2198,7 @@ public function setMaxLength($max_length) /** * Gets max_length_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getMaxLengthMetadata() @@ -1871,7 +2208,9 @@ public function getMaxLengthMetadata() /** * Sets max_length_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $max_length_metadata max_length_metadata + * * @return $this */ public function setMaxLengthMetadata($max_length_metadata) @@ -1883,6 +2222,7 @@ public function setMaxLengthMetadata($max_length_metadata) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -1892,7 +2232,9 @@ public function getMergeField() /** * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field + * + * @param \DocuSign\eSign\Model\MergeField $merge_field merge_field + * * @return $this */ public function setMergeField($merge_field) @@ -1904,6 +2246,7 @@ public function setMergeField($merge_field) /** * Gets merge_field_xml + * * @return string */ public function getMergeFieldXml() @@ -1913,7 +2256,9 @@ public function getMergeFieldXml() /** * Sets merge_field_xml + * * @param string $merge_field_xml + * * @return $this */ public function setMergeFieldXml($merge_field_xml) @@ -1925,6 +2270,7 @@ public function setMergeFieldXml($merge_field_xml) /** * Gets name + * * @return string */ public function getName() @@ -1934,7 +2280,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1946,6 +2294,7 @@ public function setName($name) /** * Gets name_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getNameMetadata() @@ -1955,7 +2304,9 @@ public function getNameMetadata() /** * Sets name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $name_metadata name_metadata + * * @return $this */ public function setNameMetadata($name_metadata) @@ -1967,6 +2318,7 @@ public function setNameMetadata($name_metadata) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -1976,7 +2328,9 @@ public function getOriginalValue() /** * Sets original_value + * * @param string $original_value The initial value of the tab when it was sent to the recipient. + * * @return $this */ public function setOriginalValue($original_value) @@ -1988,6 +2342,7 @@ public function setOriginalValue($original_value) /** * Gets original_value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getOriginalValueMetadata() @@ -1997,7 +2352,9 @@ public function getOriginalValueMetadata() /** * Sets original_value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $original_value_metadata original_value_metadata + * * @return $this */ public function setOriginalValueMetadata($original_value_metadata) @@ -2009,6 +2366,7 @@ public function setOriginalValueMetadata($original_value_metadata) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -2018,7 +2376,9 @@ public function getPageNumber() /** * Sets page_number + * * @param string $page_number Specifies the page number on which the tab is located. + * * @return $this */ public function setPageNumber($page_number) @@ -2030,6 +2390,7 @@ public function setPageNumber($page_number) /** * Gets page_number_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getPageNumberMetadata() @@ -2039,7 +2400,9 @@ public function getPageNumberMetadata() /** * Sets page_number_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $page_number_metadata page_number_metadata + * * @return $this */ public function setPageNumberMetadata($page_number_metadata) @@ -2051,6 +2414,7 @@ public function setPageNumberMetadata($page_number_metadata) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -2060,7 +2424,9 @@ public function getRecipientId() /** * 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) @@ -2072,6 +2438,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -2081,7 +2448,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -2093,6 +2462,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_id_guid_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdGuidMetadata() @@ -2102,7 +2472,9 @@ public function getRecipientIdGuidMetadata() /** * Sets recipient_id_guid_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_guid_metadata recipient_id_guid_metadata + * * @return $this */ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) @@ -2114,6 +2486,7 @@ public function setRecipientIdGuidMetadata($recipient_id_guid_metadata) /** * Gets recipient_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRecipientIdMetadata() @@ -2123,7 +2496,9 @@ public function getRecipientIdMetadata() /** * Sets recipient_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $recipient_id_metadata recipient_id_metadata + * * @return $this */ public function setRecipientIdMetadata($recipient_id_metadata) @@ -2135,6 +2510,7 @@ public function setRecipientIdMetadata($recipient_id_metadata) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -2144,7 +2520,9 @@ public function getRequireAll() /** * 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) @@ -2156,6 +2534,7 @@ public function setRequireAll($require_all) /** * Gets require_all_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireAllMetadata() @@ -2165,7 +2544,9 @@ public function getRequireAllMetadata() /** * Sets require_all_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_all_metadata require_all_metadata + * * @return $this */ public function setRequireAllMetadata($require_all_metadata) @@ -2177,6 +2558,7 @@ public function setRequireAllMetadata($require_all_metadata) /** * Gets required + * * @return string */ public function getRequired() @@ -2186,7 +2568,9 @@ public function getRequired() /** * Sets required + * * @param string $required When set to **true**, the signer is required to fill out this tab + * * @return $this */ public function setRequired($required) @@ -2198,6 +2582,7 @@ public function setRequired($required) /** * Gets required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequiredMetadata() @@ -2207,7 +2592,9 @@ public function getRequiredMetadata() /** * Sets required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $required_metadata required_metadata + * * @return $this */ public function setRequiredMetadata($required_metadata) @@ -2219,6 +2606,7 @@ public function setRequiredMetadata($required_metadata) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -2228,7 +2616,9 @@ public function getRequireInitialOnSharedChange() /** * 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) @@ -2240,6 +2630,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets require_initial_on_shared_change_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getRequireInitialOnSharedChangeMetadata() @@ -2249,7 +2640,9 @@ public function getRequireInitialOnSharedChangeMetadata() /** * Sets require_initial_on_shared_change_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $require_initial_on_shared_change_metadata require_initial_on_shared_change_metadata + * * @return $this */ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shared_change_metadata) @@ -2261,6 +2654,7 @@ public function setRequireInitialOnSharedChangeMetadata($require_initial_on_shar /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -2270,7 +2664,9 @@ public function getSenderRequired() /** * 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. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. + * * @return $this */ public function setSenderRequired($sender_required) @@ -2282,6 +2678,7 @@ public function setSenderRequired($sender_required) /** * Gets sender_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSenderRequiredMetadata() @@ -2291,7 +2688,9 @@ public function getSenderRequiredMetadata() /** * Sets sender_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $sender_required_metadata sender_required_metadata + * * @return $this */ public function setSenderRequiredMetadata($sender_required_metadata) @@ -2303,6 +2702,7 @@ public function setSenderRequiredMetadata($sender_required_metadata) /** * Gets shared + * * @return string */ public function getShared() @@ -2312,7 +2712,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -2324,6 +2726,7 @@ public function setShared($shared) /** * Gets shared_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getSharedMetadata() @@ -2333,7 +2736,9 @@ public function getSharedMetadata() /** * Sets shared_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $shared_metadata shared_metadata + * * @return $this */ public function setSharedMetadata($shared_metadata) @@ -2345,6 +2750,7 @@ public function setSharedMetadata($shared_metadata) /** * Gets smart_contract_information + * * @return \DocuSign\eSign\Model\SmartContractInformation */ public function getSmartContractInformation() @@ -2354,7 +2760,9 @@ public function getSmartContractInformation() /** * Sets smart_contract_information - * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information + * + * @param \DocuSign\eSign\Model\SmartContractInformation $smart_contract_information smart_contract_information + * * @return $this */ public function setSmartContractInformation($smart_contract_information) @@ -2366,6 +2774,7 @@ public function setSmartContractInformation($smart_contract_information) /** * Gets status + * * @return string */ public function getStatus() @@ -2375,7 +2784,9 @@ public function getStatus() /** * 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) @@ -2387,6 +2798,7 @@ public function setStatus($status) /** * Gets status_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStatusMetadata() @@ -2396,7 +2808,9 @@ public function getStatusMetadata() /** * Sets status_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $status_metadata status_metadata + * * @return $this */ public function setStatusMetadata($status_metadata) @@ -2408,6 +2822,7 @@ public function setStatusMetadata($status_metadata) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -2417,7 +2832,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -2429,6 +2846,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_group_labels_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabGroupLabelsMetadata() @@ -2438,7 +2856,9 @@ public function getTabGroupLabelsMetadata() /** * Sets tab_group_labels_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_group_labels_metadata tab_group_labels_metadata + * * @return $this */ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) @@ -2450,6 +2870,7 @@ public function setTabGroupLabelsMetadata($tab_group_labels_metadata) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -2459,7 +2880,9 @@ public function getTabId() /** * 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) @@ -2471,6 +2894,7 @@ public function setTabId($tab_id) /** * Gets tab_id_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabIdMetadata() @@ -2480,7 +2904,9 @@ public function getTabIdMetadata() /** * Sets tab_id_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_id_metadata tab_id_metadata + * * @return $this */ public function setTabIdMetadata($tab_id_metadata) @@ -2492,6 +2918,7 @@ public function setTabIdMetadata($tab_id_metadata) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -2501,7 +2928,9 @@ public function getTabLabel() /** * Sets tab_label + * * @param string $tab_label The label string associated with the tab. + * * @return $this */ public function setTabLabel($tab_label) @@ -2513,6 +2942,7 @@ public function setTabLabel($tab_label) /** * Gets tab_label_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabLabelMetadata() @@ -2522,7 +2952,9 @@ public function getTabLabelMetadata() /** * Sets tab_label_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_label_metadata tab_label_metadata + * * @return $this */ public function setTabLabelMetadata($tab_label_metadata) @@ -2534,6 +2966,7 @@ public function setTabLabelMetadata($tab_label_metadata) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -2543,7 +2976,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -2555,6 +2990,7 @@ public function setTabOrder($tab_order) /** * Gets tab_order_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabOrderMetadata() @@ -2564,7 +3000,9 @@ public function getTabOrderMetadata() /** * Sets tab_order_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_order_metadata tab_order_metadata + * * @return $this */ public function setTabOrderMetadata($tab_order_metadata) @@ -2576,6 +3014,7 @@ public function setTabOrderMetadata($tab_order_metadata) /** * Gets tab_type + * * @return string */ public function getTabType() @@ -2585,7 +3024,9 @@ public function getTabType() /** * Sets tab_type + * * @param string $tab_type + * * @return $this */ public function setTabType($tab_type) @@ -2597,6 +3038,7 @@ public function setTabType($tab_type) /** * Gets tab_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTabTypeMetadata() @@ -2606,7 +3048,9 @@ public function getTabTypeMetadata() /** * Sets tab_type_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tab_type_metadata tab_type_metadata + * * @return $this */ public function setTabTypeMetadata($tab_type_metadata) @@ -2618,6 +3062,7 @@ public function setTabTypeMetadata($tab_type_metadata) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -2627,7 +3072,9 @@ public function getTemplateLocked() /** * 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) @@ -2639,6 +3086,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_locked_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateLockedMetadata() @@ -2648,7 +3096,9 @@ public function getTemplateLockedMetadata() /** * Sets template_locked_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_locked_metadata template_locked_metadata + * * @return $this */ public function setTemplateLockedMetadata($template_locked_metadata) @@ -2660,6 +3110,7 @@ public function setTemplateLockedMetadata($template_locked_metadata) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -2669,7 +3120,9 @@ public function getTemplateRequired() /** * 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) @@ -2681,6 +3134,7 @@ public function setTemplateRequired($template_required) /** * Gets template_required_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getTemplateRequiredMetadata() @@ -2690,7 +3144,9 @@ public function getTemplateRequiredMetadata() /** * Sets template_required_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $template_required_metadata template_required_metadata + * * @return $this */ public function setTemplateRequiredMetadata($template_required_metadata) @@ -2702,6 +3158,7 @@ public function setTemplateRequiredMetadata($template_required_metadata) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -2711,7 +3168,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -2723,6 +3182,7 @@ public function setTooltip($tooltip) /** * Gets tool_tip_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getToolTipMetadata() @@ -2732,7 +3192,9 @@ public function getToolTipMetadata() /** * Sets tool_tip_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $tool_tip_metadata tool_tip_metadata + * * @return $this */ public function setToolTipMetadata($tool_tip_metadata) @@ -2744,6 +3206,7 @@ public function setToolTipMetadata($tool_tip_metadata) /** * Gets underline + * * @return string */ public function getUnderline() @@ -2753,7 +3216,9 @@ public function getUnderline() /** * Sets underline + * * @param string $underline When set to **true**, the information in the tab is underlined. + * * @return $this */ public function setUnderline($underline) @@ -2765,6 +3230,7 @@ public function setUnderline($underline) /** * Gets underline_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUnderlineMetadata() @@ -2774,7 +3240,9 @@ public function getUnderlineMetadata() /** * Sets underline_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $underline_metadata underline_metadata + * * @return $this */ public function setUnderlineMetadata($underline_metadata) @@ -2786,6 +3254,7 @@ public function setUnderlineMetadata($underline_metadata) /** * Gets use_dash4 + * * @return string */ public function getUseDash4() @@ -2795,7 +3264,9 @@ public function getUseDash4() /** * Sets use_dash4 + * * @param string $use_dash4 + * * @return $this */ public function setUseDash4($use_dash4) @@ -2807,6 +3278,7 @@ public function setUseDash4($use_dash4) /** * Gets use_dash4_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getUseDash4Metadata() @@ -2816,7 +3288,9 @@ public function getUseDash4Metadata() /** * Sets use_dash4_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $use_dash4_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $use_dash4_metadata use_dash4_metadata + * * @return $this */ public function setUseDash4Metadata($use_dash4_metadata) @@ -2828,6 +3302,7 @@ public function setUseDash4Metadata($use_dash4_metadata) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -2837,7 +3312,9 @@ public function getValidationMessage() /** * Sets validation_message + * * @param string $validation_message The message displayed if the custom tab fails input validation (either custom of embedded). + * * @return $this */ public function setValidationMessage($validation_message) @@ -2849,6 +3326,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_message_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationMessageMetadata() @@ -2858,7 +3336,9 @@ public function getValidationMessageMetadata() /** * Sets validation_message_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_message_metadata validation_message_metadata + * * @return $this */ public function setValidationMessageMetadata($validation_message_metadata) @@ -2870,6 +3350,7 @@ public function setValidationMessageMetadata($validation_message_metadata) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -2879,7 +3360,9 @@ public function getValidationPattern() /** * Sets validation_pattern + * * @param string $validation_pattern A regular expression used to validate input for the tab. + * * @return $this */ public function setValidationPattern($validation_pattern) @@ -2891,6 +3374,7 @@ public function setValidationPattern($validation_pattern) /** * Gets validation_pattern_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValidationPatternMetadata() @@ -2900,7 +3384,9 @@ public function getValidationPatternMetadata() /** * Sets validation_pattern_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $validation_pattern_metadata validation_pattern_metadata + * * @return $this */ public function setValidationPatternMetadata($validation_pattern_metadata) @@ -2912,6 +3398,7 @@ public function setValidationPatternMetadata($validation_pattern_metadata) /** * Gets value + * * @return string */ public function getValue() @@ -2921,7 +3408,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -2933,6 +3422,7 @@ public function setValue($value) /** * Gets value_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getValueMetadata() @@ -2942,7 +3432,9 @@ public function getValueMetadata() /** * Sets value_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $value_metadata value_metadata + * * @return $this */ public function setValueMetadata($value_metadata) @@ -2954,6 +3446,7 @@ public function setValueMetadata($value_metadata) /** * Gets width + * * @return string */ public function getWidth() @@ -2963,7 +3456,9 @@ public function getWidth() /** * Sets width + * * @param string $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -2975,6 +3470,7 @@ public function setWidth($width) /** * Gets width_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getWidthMetadata() @@ -2984,7 +3480,9 @@ public function getWidthMetadata() /** * Sets width_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $width_metadata width_metadata + * * @return $this */ public function setWidthMetadata($width_metadata) @@ -2996,6 +3494,7 @@ public function setWidthMetadata($width_metadata) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -3005,7 +3504,9 @@ public function getXPosition() /** * 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) @@ -3017,6 +3518,7 @@ public function setXPosition($x_position) /** * Gets x_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getXPositionMetadata() @@ -3026,7 +3528,9 @@ public function getXPositionMetadata() /** * Sets x_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $x_position_metadata x_position_metadata + * * @return $this */ public function setXPositionMetadata($x_position_metadata) @@ -3038,6 +3542,7 @@ public function setXPositionMetadata($x_position_metadata) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -3047,7 +3552,9 @@ public function getYPosition() /** * 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) @@ -3059,6 +3566,7 @@ public function setYPosition($y_position) /** * Gets y_position_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getYPositionMetadata() @@ -3068,7 +3576,9 @@ public function getYPositionMetadata() /** * Sets y_position_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata + * + * @param \DocuSign\eSign\Model\PropertyMetadata $y_position_metadata y_position_metadata + * * @return $this */ public function setYPositionMetadata($y_position_metadata) @@ -3079,7 +3589,9 @@ public function setYPositionMetadata($y_position_metadata) } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -3089,7 +3601,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -3099,8 +3613,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -3114,7 +3630,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -3124,16 +3642,19 @@ public function offsetUnset($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( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/ObjectSerializer.php b/src/ObjectSerializer.php index 13a1a0b0..2e98bc99 100644 --- a/src/ObjectSerializer.php +++ b/src/ObjectSerializer.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2.1 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -42,27 +42,43 @@ class ObjectSerializer /** * Serialize data * - * @param mixed $data the data to serialize + * @param mixed $data the data to serialize + * @param string $type the SwaggerType of the data + * @param string $format the format of the Swagger type of the data * * @return string|object serialized form of $data */ - public static function sanitizeForSerialization($data) + public static function sanitizeForSerialization($data, $type = null, $format = null) { if (is_scalar($data) || null === $data) { return $data; } elseif ($data instanceof \DateTime) { - return $data->format(\DateTime::ATOM); + return ($format === 'date') ? $data->format('Y-m-d') : $data->format(\DateTime::ATOM); } elseif (is_array($data)) { foreach ($data as $property => $value) { $data[$property] = self::sanitizeForSerialization($value); } return $data; + } elseif ($data instanceof \stdClass) { + foreach ($data as $property => $value) { + $data->$property = self::sanitizeForSerialization($value); + } + return $data; } elseif (is_object($data)) { $values = []; - foreach (array_keys($data::swaggerTypes()) as $property) { + $formats = $data::swaggerFormats(); + foreach ($data::swaggerTypes() as $property => $swaggerType) { $getter = $data::getters()[$property]; - if ($data->$getter() !== null) { - $values[$data::attributeMap()[$property]] = self::sanitizeForSerialization($data->$getter()); + $value = $data->$getter(); + if ($value !== null + && !in_array($swaggerType, ['DateTime', 'bool', 'boolean', 'byte', 'double', 'float', 'int', 'integer', 'mixed', 'number', 'object', 'string', 'void'], true) + && method_exists($swaggerType, 'getAllowableEnumValues') + && !in_array($value, $swaggerType::getAllowableEnumValues(), true)) { + $imploded = implode("', '", $swaggerType::getAllowableEnumValues()); + throw new \InvalidArgumentException("Invalid value for enum '$swaggerType', must be one of: '$imploded'"); + } + if ($value !== null) { + $values[$data::attributeMap()[$property]] = self::sanitizeForSerialization($value, $swaggerType, $formats[$property]); } } return (object)$values; @@ -79,7 +95,7 @@ public static function sanitizeForSerialization($data) * * @return string the sanitized filename */ - public function sanitizeFilename($filename) + public static function sanitizeFilename($filename) { if (preg_match("/.*[\/\\\\](.*)$/", $filename, $match)) { return $match[1]; @@ -96,9 +112,9 @@ public function sanitizeFilename($filename) * * @return string the serialized object */ - public function toPathValue($value) + public static function toPathValue($value) { - return rawurlencode($this->toString($value)); + return rawurlencode(self::toString($value)); } /** @@ -111,12 +127,12 @@ public function toPathValue($value) * * @return string the serialized object */ - public function toQueryValue($object) + public static function toQueryValue($object) { if (is_array($object)) { return implode(',', $object); } else { - return $this->toString($object); + return self::toString($object); } } @@ -129,9 +145,9 @@ public function toQueryValue($object) * * @return string the header string */ - public function toHeaderValue($value) + public static function toHeaderValue($value) { - return $this->toString($value); + return self::toString($value); } /** @@ -143,12 +159,12 @@ public function toHeaderValue($value) * * @return string the form string */ - public function toFormValue($value) + public static function toFormValue($value) { if ($value instanceof \SplFileObject) { return $value->getRealPath(); } else { - return $this->toString($value); + return self::toString($value); } } @@ -161,7 +177,7 @@ public function toFormValue($value) * * @return string the header string */ - public function toString($value) + public static function toString($value) { if ($value instanceof \DateTime) { // datetime in ISO8601 format return $value->format(\DateTime::ATOM); @@ -180,7 +196,7 @@ public function toString($value) * * @return string */ - public function serializeCollection(array $collection, $collectionFormat, $allowCollectionFormatMulti = false) + public static function serializeCollection(array $collection, $collectionFormat, $allowCollectionFormatMulti = false) { if ($allowCollectionFormatMulti && ('multi' === $collectionFormat)) { // http_build_query() almost does the job for us. We just @@ -255,20 +271,29 @@ public static function deserialize($data, $class, $httpHeaders = null) settype($data, $class); return $data; } elseif ($class === '\SplFileObject') { + /** @var \Psr\Http\Message\StreamInterface $data */ + // determine file name if (array_key_exists('Content-Disposition', $httpHeaders) && preg_match('/inline; filename=[\'"]?([^\'"\s]+)[\'"]?$/i', $httpHeaders['Content-Disposition'], $match)) { - $filename = Configuration::getDefaultConfiguration()->getTempFolderPath() . sanitizeFilename($match[1]); + $filename = Configuration::getDefaultConfiguration()->getTempFolderPath() . DIRECTORY_SEPARATOR . self::sanitizeFilename($match[1]); } else { $filename = tempnam(Configuration::getDefaultConfiguration()->getTempFolderPath(), ''); } - $deserialized = new \SplFileObject($filename, "w"); - $byte_written = $deserialized->fwrite($data); - if (Configuration::getDefaultConfiguration()->getDebug()) { - error_log("[DEBUG] Written $byte_written byte to $filename. Please move the file to a proper folder or delete the temp file after processing.".PHP_EOL, 3, Configuration::getDefaultConfiguration()->getDebugFile()); + + $file = fopen($filename, 'w'); + while ($chunk = $data->read(200)) { + fwrite($file, $chunk); } + fclose($file); - return $deserialized; + return new \SplFileObject($filename, 'r'); + } elseif (method_exists($class, 'getAllowableEnumValues')) { + if (!in_array($data, $class::getAllowableEnumValues(), true)) { + $imploded = implode("', '", $class::getAllowableEnumValues()); + throw new \InvalidArgumentException("Invalid value for enum '$class', must be one of: '$imploded'"); + } + return $data; } else { // If a discriminator is defined and points to a valid subclass, use it. $discriminator = $class::DISCRIMINATOR;